1. default

1.1. 功能说明 controller:SysPurviewSettings

1.1.1. 1.数据查询

URL: http://127.0.0.1:9010/sysPurviewSettings/search

Type: POST

Author: meng

Content-Type: application/json

Description: 1.数据查询

Request-headers:

	Header	Value	Type	Required	Description
	Authorization		String	false	Access Token

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Body-parameters:

Parameter	Type	Required	Description
current	int32	false	页码
size	int32	false	页大小
keyword	string	false	搜索关键字
orders	array	false	排序
└─column	string	false	属性名称
└─asc	boolean	false	是否升序
ids	array	false	id集 nullable : false default : null
id	int64	false	记录唯一ID nullable : false default : null
pid	int64	false	业务id nullable : false default : null
rid	int64	false	用户id nullable : false default : null
appType	string	false	app类型 nullable : false default : null
appStatus	string	false	app状态 nullable : false default : null
tenantId	int64	false	租户ID nullable : true default : null
remark	string	false	备注 nullable : true default : null
createUserId	int64	false	记录创建者ID nullable : true default : null
creator	string	false	记录创建者 nullable : true default : null
createTime	string	false	记录创建时间 nullable : true default : null
modifyUserId	int64	false	记录最后更新者ID nullable : true default : null
updater	string	false	记录最后更新者 nullable : true default : null
modifyTime	string	false	记录最后更新时间 nullable : true default : null
deleteFlag	int32	false	逻辑删除，0：未删除，1：已删除 nullable : false default : null
auditDataVersion	int32	false	锁版本 nullable : true default : null
secBuId	int64	false	sec_bu_id nullable : true default : null
secUserId	int64	false	sec_user_id nullable : true default : null
secOuId	int64	false	sec_ou_id nullable : true default : null
dpowerCode	string	false	No comments found.
powerFlag	string	false	No comments found.

Parameter

Type

Required

Description

current

int32

false

页码

size

int32

false

页大小

keyword

string

false

搜索关键字

orders

array

false

排序

└─column

string

false

属性名称

└─asc

boolean

false

是否升序

ids

array

false

id集
nullable : false
default : null

int64

false

记录唯一ID
nullable : false
default : null

pid

int64

false

业务id
nullable : false
default : null

rid

int64

false

用户id
nullable : false
default : null

appType

string

false

app类型
nullable : false
default : null

appStatus

string

false

app状态
nullable : false
default : null

tenantId

int64

false

租户ID
nullable : true
default : null

remark

string

false

备注
nullable : true
default : null

createUserId

int64

false

记录创建者ID
nullable : true
default : null

creator

string

false

记录创建者
nullable : true
default : null

createTime

string

false

记录创建时间
nullable : true
default : null

modifyUserId

int64

false

记录最后更新者ID
nullable : true
default : null

updater

string

false

记录最后更新者
nullable : true
default : null

modifyTime

string

false

记录最后更新时间
nullable : true
default : null

deleteFlag

int32

false

逻辑删除，0：未删除，1：已删除
nullable : false
default : null

auditDataVersion

int32

false

锁版本
nullable : true
default : null

secBuId

int64

false

sec_bu_id
nullable : true
default : null

secUserId

int64

false

sec_user_id
nullable : true
default : null

secOuId

int64

false

sec_ou_id
nullable : true
default : null

dpowerCode

string

false

No comments found.

powerFlag

string

false

No comments found.

Request-body:

{
  "current": 81,
  "size": 10,
  "keyword": "ya9qbr",
  "orders": [
    {
      "column": "dw2opg",
      "asc": true
    }
  ],
  "ids": [
    764
  ],
  "id": 38,
  "pid": 735,
  "rid": 168,
  "appType": "elg5qt",
  "appStatus": "xvha0q",
  "tenantId": 384,
  "remark": "o1973w",
  "createUserId": 126,
  "creator": "o9chhf",
  "createTime": "2023-02-13 08:31:51",
  "modifyUserId": 20,
  "updater": "52chef",
  "modifyTime": "2023-02-13 08:31:51",
  "deleteFlag": 9,
  "auditDataVersion": 385,
  "secBuId": 388,
  "secUserId": 489,
  "secOuId": 706,
  "dpowerCode": "99507",
  "powerFlag": "vepl15"
}

Response-fields:

Field	Type	Description	Since
code	int32	响应码	-
msg	string	响应消息	-
errorMsg	string	错误信息	-
success	boolean	是否成功	-
errorNo	string	错误号	-
data	array	响应数据	-
└─id	int64	记录唯一ID nullable : false default : null	-
└─pid	int64	业务id nullable : false default : null	-
└─rid	int64	用户id nullable : false default : null	-
└─appType	string	app类型 nullable : false default : null	-
└─appStatus	string	app状态 nullable : false default : null	-
└─tenantId	int64	租户ID nullable : true default : null	-
└─remark	string	备注 nullable : true default : null	-
└─createUserId	int64	记录创建者ID nullable : true default : null	-
└─creator	string	记录创建者 nullable : true default : null	-
└─createTime	string	记录创建时间 nullable : true default : null	-
└─modifyUserId	int64	记录最后更新者ID nullable : true default : null	-
└─updater	string	记录最后更新者 nullable : true default : null	-
└─modifyTime	string	记录最后更新时间 nullable : true default : null	-
└─deleteFlag	int32	逻辑删除，0：未删除，1：已删除 nullable : false default : null	-
└─auditDataVersion	int32	锁版本 nullable : true default : null	-
└─secBuId	int64	sec_bu_id nullable : true default : null	-
└─secUserId	int64	sec_user_id nullable : true default : null	-
└─secOuId	int64	sec_ou_id nullable : true default : null	-
└─dpowerCode	string	No comments found.	-
└─powerFlag	string	No comments found.	-
time	string	响应时间	-

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

array

响应数据

└─id

int64

记录唯一ID
nullable : false
default : null

└─pid

int64

业务id
nullable : false
default : null

└─rid

int64

用户id
nullable : false
default : null

└─appType

string

app类型
nullable : false
default : null

└─appStatus

string

app状态
nullable : false
default : null

└─tenantId

int64

租户ID
nullable : true
default : null

└─remark

string

备注
nullable : true
default : null

└─createUserId

int64

记录创建者ID
nullable : true
default : null

└─creator

string

记录创建者
nullable : true
default : null

└─createTime

string

记录创建时间
nullable : true
default : null

└─modifyUserId

int64

记录最后更新者ID
nullable : true
default : null

└─updater

string

记录最后更新者
nullable : true
default : null

└─modifyTime

string

记录最后更新时间
nullable : true
default : null

└─deleteFlag

int32

逻辑删除，0：未删除，1：已删除
nullable : false
default : null

└─auditDataVersion

int32

锁版本
nullable : true
default : null

└─secBuId

int64

sec_bu_id
nullable : true
default : null

└─secUserId

int64

sec_user_id
nullable : true
default : null

└─secOuId

int64

sec_ou_id
nullable : true
default : null

└─dpowerCode

string

No comments found.

└─powerFlag

string

No comments found.

time

string

响应时间

Response-example:

{
  "code": 303,
  "msg": "by09yz",
  "errorMsg": "3r3xk6",
  "success": true,
  "errorNo": "eiwfpe",
  "data": [
    {
      "id": 925,
      "pid": 77,
      "rid": 423,
      "appType": "2ost9b",
      "appStatus": "lktaop",
      "tenantId": 731,
      "remark": "bnzp4g",
      "createUserId": 865,
      "creator": "i66hhk",
      "createTime": "2023-02-13 08:31:51",
      "modifyUserId": 546,
      "updater": "ri4ta6",
      "modifyTime": "2023-02-13 08:31:51",
      "deleteFlag": 9,
      "auditDataVersion": 46,
      "secBuId": 374,
      "secUserId": 20,
      "secOuId": 144,
      "dpowerCode": "99507",
      "powerFlag": "fzhjj4"
    }
  ],
  "time": "2023-02-13 08:31:51"
}

Curl-example:

curl -X POST -H 'Content-Type: application/json' -H 'Authorization' -i http://127.0.0.1:9010/sysPurviewSettings/search --data '{
  "current": 81,
  "size": 10,
  "keyword": "ya9qbr",
  "orders": [
    {
      "column": "dw2opg",
      "asc": true
    }
  ],
  "ids": [
    764
  ],
  "id": 38,
  "pid": 735,
  "rid": 168,
  "appType": "elg5qt",
  "appStatus": "xvha0q",
  "tenantId": 384,
  "remark": "o1973w",
  "createUserId": 126,
  "creator": "o9chhf",
  "createTime": "2023-02-13 08:31:51",
  "modifyUserId": 20,
  "updater": "52chef",
  "modifyTime": "2023-02-13 08:31:51",
  "deleteFlag": 9,
  "auditDataVersion": 385,
  "secBuId": 388,
  "secUserId": 489,
  "secOuId": 706,
  "dpowerCode": "99507",
  "powerFlag": "vepl15"
}'

1.1.2. 7.新增数据批量

URL: http://127.0.0.1:9010/sysPurviewSettings/createAll

Type: POST

Author: meng

Content-Type: application/json

Description: 7.新增数据批量

Request-headers:

	Header	Value	Type	Required	Description
	Authorization		String	false	Access Token

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Body-parameters:

Parameter	Type	Required	Description
id	int64	false	记录唯一ID nullable : false default : null
pid	int64	false	业务id nullable : false default : null
rid	int64	false	用户id nullable : false default : null
appType	string	false	app类型 nullable : false default : null
appStatus	string	false	app状态 nullable : false default : null
tenantId	int64	false	租户ID nullable : true default : null
remark	string	false	备注 nullable : true default : null
createUserId	int64	false	记录创建者ID nullable : true default : null
creator	string	false	记录创建者 nullable : true default : null
createTime	string	false	记录创建时间 nullable : true default : null
modifyUserId	int64	false	记录最后更新者ID nullable : true default : null
updater	string	false	记录最后更新者 nullable : true default : null
modifyTime	string	false	记录最后更新时间 nullable : true default : null
deleteFlag	int32	false	逻辑删除，0：未删除，1：已删除 nullable : false default : null
auditDataVersion	int32	false	锁版本 nullable : true default : null
secBuId	int64	false	sec_bu_id nullable : true default : null
secUserId	int64	false	sec_user_id nullable : true default : null
secOuId	int64	false	sec_ou_id nullable : true default : null
dpowerCode	string	false	No comments found.
powerFlag	string	false	No comments found.

Parameter

Type

Required

Description

int64

false

记录唯一ID
nullable : false
default : null

pid

int64

false

业务id
nullable : false
default : null

rid

int64

false

用户id
nullable : false
default : null

appType

string

false

app类型
nullable : false
default : null

appStatus

string

false

app状态
nullable : false
default : null

tenantId

int64

false

租户ID
nullable : true
default : null

remark

string

false

备注
nullable : true
default : null

createUserId

int64

false

记录创建者ID
nullable : true
default : null

creator

string

false

记录创建者
nullable : true
default : null

createTime

string

false

记录创建时间
nullable : true
default : null

modifyUserId

int64

false

记录最后更新者ID
nullable : true
default : null

updater

string

false

记录最后更新者
nullable : true
default : null

modifyTime

string

false

记录最后更新时间
nullable : true
default : null

deleteFlag

int32

false

逻辑删除，0：未删除，1：已删除
nullable : false
default : null

auditDataVersion

int32

false

锁版本
nullable : true
default : null

secBuId

int64

false

sec_bu_id
nullable : true
default : null

secUserId

int64

false

sec_user_id
nullable : true
default : null

secOuId

int64

false

sec_ou_id
nullable : true
default : null

dpowerCode

string

false

No comments found.

powerFlag

string

false

No comments found.

Request-body:

[
  {
    "id": 317,
    "pid": 429,
    "rid": 340,
    "appType": "mbnwjw",
    "appStatus": "75fysq",
    "tenantId": 711,
    "remark": "rfx3kc",
    "createUserId": 226,
    "creator": "ywkdgm",
    "createTime": "2023-02-13 08:31:51",
    "modifyUserId": 433,
    "updater": "9nwiew",
    "modifyTime": "2023-02-13 08:31:51",
    "deleteFlag": 9,
    "auditDataVersion": 467,
    "secBuId": 19,
    "secUserId": 63,
    "secOuId": 565,
    "dpowerCode": "99507",
    "powerFlag": "zxa39y"
  }
]

Response-fields:

Field	Type	Description	Since
code	int32	响应码	-
msg	string	响应消息	-
errorMsg	string	错误信息	-
success	boolean	是否成功	-
errorNo	string	错误号	-
data	object	响应数据	-
time	string	响应时间	-

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

time

string

响应时间

Response-example:

{
  "code": 715,
  "msg": "mxod62",
  "errorMsg": "he364b",
  "success": true,
  "errorNo": "hzm7jc",
  "data": {},
  "time": "2023-02-13 08:31:51"
}

Curl-example:

curl -X POST -H 'Content-Type: application/json' -H 'Authorization' -i http://127.0.0.1:9010/sysPurviewSettings/createAll --data '[
  {
    "id": 317,
    "pid": 429,
    "rid": 340,
    "appType": "mbnwjw",
    "appStatus": "75fysq",
    "tenantId": 711,
    "remark": "rfx3kc",
    "createUserId": 226,
    "creator": "ywkdgm",
    "createTime": "2023-02-13 08:31:51",
    "modifyUserId": 433,
    "updater": "9nwiew",
    "modifyTime": "2023-02-13 08:31:51",
    "deleteFlag": 9,
    "auditDataVersion": 467,
    "secBuId": 19,
    "secUserId": 63,
    "secOuId": 565,
    "dpowerCode": "99507",
    "powerFlag": "zxa39y"
  }
]'

1.2. 系统日志.

1.2.1. 获取应用名称列表

URL: http://127.0.0.1:9010/logStash/appName

Type: GET

Author: Kaiser（wang shao）

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 获取应用名称列表

Request-headers:

	Header	Value	Type	Required	Description
	Authorization		String	false	Access Token

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Query-parameters:

Parameter	Type	Required	Description
size	int32	false	获取名称的最多数量，默认20
startTime	string	false	开始时间
endTime	string	false	截止时间

Parameter

Value

Type

Required

Description

size

int32

false

获取名称的最多数量，默认20

startTime

string

false

开始时间

endTime

string

false

截止时间

Response-fields:

Field	Type	Description	Since
code	int32	响应码	-
msg	string	响应消息	-
errorMsg	string	错误信息	-
success	boolean	是否成功	-
errorNo	string	错误号	-
data	array	响应数据	-
time	string	响应时间	-

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

array

响应数据

time

string

响应时间

Response-example:

{
  "code": 681,
  "msg": "zy1t7u",
  "errorMsg": "gior9h",
  "success": true,
  "errorNo": "d8ms3g",
  "data": [
    "3yzk2l",
    "2te27u"
  ],
  "time": "2023-02-13 08:31:53"
}

Curl-example:

curl -X GET -H 'Authorization' -i http://127.0.0.1:9010/logStash/appName?size=10&startTime=2023-02-13 08:31:53&endTime=2023-02-13 08:31:53

1.2.2. 获取日志级别列表

URL: http://127.0.0.1:9010/logStash/logLevel

Type: GET

Author: Kaiser（wang shao）

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 获取日志级别列表

Request-headers:

	Header	Value	Type	Required	Description
	Authorization		String	false	Access Token

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Response-fields:

Field	Type	Description	Since
code	int32	响应码	-
msg	string	响应消息	-
errorMsg	string	错误信息	-
success	boolean	是否成功	-
errorNo	string	错误号	-
data	array	响应数据	-
time	string	响应时间	-

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

array

响应数据

time

string

响应时间

Response-example:

{
  "code": 624,
  "msg": "ywkbkr",
  "errorMsg": "mfqirm",
  "success": true,
  "errorNo": "uljeru",
  "data": [
    "worolv",
    "z3ioe3"
  ],
  "time": "2023-02-13 08:31:53"
}

Curl-example:

curl -X GET -H 'Authorization' -i http://127.0.0.1:9010/logStash/logLevel

1.2.3. 搜索日志

URL: http://127.0.0.1:9010/logStash/search

Type: POST

Author: Kaiser（wang shao）

Content-Type: application/json

Description: 搜索日志

Request-headers:

	Header	Value	Type	Required	Description
	Authorization		String	false	Access Token

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Body-parameters:

Parameter	Type	Required	Description
page	int32	false	No comments found.
pageSize	int32	false	No comments found.
keyword	string	false	No comments found.
highlight	object	false	No comments found.
└─preTag	string	false	No comments found.
└─postTag	string	false	No comments found.
appName	string	false	No comments found.
logLevel	enum	false	null TRACE DEBUG INFO WARN ERROR FATAL OFF
logLevelMin	enum	false	null TRACE DEBUG INFO WARN ERROR FATAL OFF
startTime	string	false	No comments found.
endTime	string	false	No comments found.
traceId	string	false	No comments found.
threadId	string	false	No comments found.

Parameter

Type

Required

Description

page

int32

false

No comments found.

pageSize

int32

false

No comments found.

keyword

string

false

No comments found.

highlight

object

false

No comments found.

└─preTag

string

false

No comments found.

└─postTag

string

false

No comments found.

appName

string

false

No comments found.

logLevel

enum

false

null
TRACE
DEBUG
INFO
WARN
ERROR
FATAL
OFF

logLevelMin

enum

false

null
TRACE
DEBUG
INFO
WARN
ERROR
FATAL
OFF

startTime

string

false

No comments found.

endTime

string

false

No comments found.

traceId

string

false

No comments found.

threadId

string

false

No comments found.

Request-body:

{
  "page": 1,
  "pageSize": 10,
  "keyword": "aw1oaa",
  "highlight": {
    "preTag": "zzjaff",
    "postTag": "t1622x"
  },
  "appName": "marg.collier",
  "logLevel": "TRACE",
  "logLevelMin": "TRACE",
  "startTime": "2023-02-13 08:31:53",
  "endTime": "2023-02-13 08:31:53",
  "traceId": "75d7eca1-4f1d-4a5a-87c4-376d030cb00d",
  "threadId": "173"
}

Response-fields:

Field	Type	Description	Since
code	int32	响应码	-
msg	string	响应消息	-
errorMsg	string	错误信息	-
success	boolean	是否成功	-
errorNo	string	错误号	-
data	object	响应数据	-
└─total	int64	总记录数	-
└─records	array	数据列表	-
└─preIndex	string	No comments found.	-
└─appName	string	No comments found.	-
└─logLevel	string	No comments found.	-
└─msg	string	No comments found.	-
└─time	string	No comments found.	-
└─message	string	No comments found.	-
time	string	响应时间	-

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

└─total

int64

总记录数

└─records

array

数据列表

└─preIndex

string

No comments found.

└─appName

string

No comments found.

└─logLevel

string

No comments found.

└─msg

string

No comments found.

└─time

string

No comments found.

└─message

string

No comments found.

time

string

响应时间

Response-example:

{
  "code": 728,
  "msg": "bzousb",
  "errorMsg": "djq71q",
  "success": true,
  "errorNo": "33ugua",
  "data": {
    "total": 676,
    "records": [
      {
        "preIndex": "kdfzqr",
        "appName": "marg.collier",
        "logLevel": "5yzygu",
        "msg": "8uask4",
        "time": "2023-02-13 08:31:53",
        "message": "success"
      }
    ]
  },
  "time": "2023-02-13 08:31:53"
}

Curl-example:

curl -X POST -H 'Content-Type: application/json' -H 'Authorization' -i http://127.0.0.1:9010/logStash/search --data '{
  "page": 1,
  "pageSize": 10,
  "keyword": "aw1oaa",
  "highlight": {
    "preTag": "zzjaff",
    "postTag": "t1622x"
  },
  "appName": "marg.collier",
  "logLevel": "TRACE",
  "logLevelMin": "TRACE",
  "startTime": "2023-02-13 08:31:53",
  "endTime": "2023-02-13 08:31:53",
  "traceId": "75d7eca1-4f1d-4a5a-87c4-376d030cb00d",
  "threadId": "173"
}'

1.3.

1.3.1.

URL: http://127.0.0.1:9010/sys/dubbo/test/user/flowRoles

Type: POST

Author: Chris

Content-Type: application/json

Description:

Request-headers:

	Header	Value	Type	Required	Description
	Authorization		String	false	Access Token

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Body-parameters:

Parameter	Type	Required	Description
flowRoleCodes	array	false	流程角色编号列表
ouIds	array	false	公司ID 列表
buIds	array	false	组织ID 列表

Parameter

Type

Required

Description

flowRoleCodes

array

false

流程角色编号列表

ouIds

array

false

公司ID 列表

buIds

array

false

组织ID 列表

Request-body:

{
  "flowRoleCodes": [
    "6ywmmk"
  ],
  "ouIds": [
    383
  ],
  "buIds": [
    189
  ]
}

Response-example:

Curl-example:

curl -X POST -H 'Content-Type: application/json' -H 'Authorization' -i http://127.0.0.1:9010/sys/dubbo/test/user/flowRoles --data '{
  "flowRoleCodes": [
    "6ywmmk"
  ],
  "ouIds": [
    383
  ],
  "buIds": [
    189
  ]
}'

1.3.2.

URL: http://127.0.0.1:9010/sys/dubbo/test/user/rpc/dto

Type: POST

Author: Chris

Content-Type: application/json

Description:

Request-headers:

	Header	Value	Type	Required	Description
	Authorization		String	false	Access Token

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Body-parameters:

Parameter	Type	Required	Description
userIds	array	false	用户ID
usernames	array	false	用户名
emails	array	false	邮箱地址
mobiles	array	false	手机号
sourceTypes	array	false	来源
roleIds	array	false	应用角色ID列表
enabled	boolean	false	是否启用
repeatMobile	string	false	手机号：用于模糊搜索匹配重复手机号
repeatEmail	string	false	邮箱：用于模糊搜索匹配重复邮箱

Parameter

Type

Required

Description

userIds

array

false

用户ID

usernames

array

false

用户名

emails

array

false

邮箱地址

mobiles

array

false

手机号

sourceTypes

array

false

来源

roleIds

array

false

应用角色ID列表

enabled

boolean

false

是否启用

repeatMobile

string

false

手机号：用于模糊搜索匹配重复手机号

repeatEmail

string

false

邮箱：用于模糊搜索匹配重复邮箱

Request-body:

{
  "userIds": [
    985
  ],
  "usernames": [
    "8s38zi"
  ],
  "emails": [
    "6892ly"
  ],
  "mobiles": [
    "87q4yi"
  ],
  "sourceTypes": [
    "rhfy6e"
  ],
  "roleIds": [
    452
  ],
  "enabled": true,
  "repeatMobile": "(734) 208-3091",
  "repeatEmail": "celinda.goldner@gmail.com"
}

Response-fields:

Field	Type	Description	Since
id	int64	用户ID	-
username	string	用户账号名称	-
lastName	string	用户姓氏	-
firstName	string	用户名称	-
mobile	string	用户手机号码	-
email	string	用户邮箱地址	-
sourceType	string	账号来源, sys：系统创建；wec：微信创建；oth：其他方式	-
enabled	boolean	是否启用	-
needReset	boolean	密码是否需要重新设置	-
avatarUrl	string	用户头像地址，可直接访问，如微信头像链接等	-
avatarCode	string	用户头像在文件服务器中的标识	-
wxOpenid	string	微信openid	-

Field

Type

Description

Since

int64

用户ID

username

string

用户账号名称

lastName

string

用户姓氏

firstName

string

用户名称

mobile

string

用户手机号码

string

用户邮箱地址

sourceType

string

账号来源, sys：系统创建；wec：微信创建；oth：其他方式

enabled

boolean

是否启用

needReset

boolean

密码是否需要重新设置

avatarUrl

string

用户头像地址，可直接访问，如微信头像链接等

avatarCode

string

用户头像在文件服务器中的标识

wxOpenid

string

微信openid

Response-example:

[
  {
    "id": 120,
    "username": "marg.collier",
    "lastName": "marg.collier",
    "firstName": "marg.collier",
    "mobile": "(734) 208-3091",
    "email": "celinda.goldner@gmail.com",
    "sourceType": "s961o7",
    "enabled": true,
    "needReset": true,
    "avatarUrl": "www.williams-bashirian.biz",
    "avatarCode": "99507",
    "wxOpenid": "173"
  }
]

Curl-example:

curl -X POST -H 'Content-Type: application/json' -H 'Authorization' -i http://127.0.0.1:9010/sys/dubbo/test/user/rpc/dto --data '{
  "userIds": [
    985
  ],
  "usernames": [
    "8s38zi"
  ],
  "emails": [
    "6892ly"
  ],
  "mobiles": [
    "87q4yi"
  ],
  "sourceTypes": [
    "rhfy6e"
  ],
  "roleIds": [
    452
  ],
  "enabled": true,
  "repeatMobile": "(734) 208-3091",
  "repeatEmail": "celinda.goldner@gmail.com"
}'

1.3.3.

URL: http://127.0.0.1:9010/sys/dubbo/test/role/rpc/dto

Type: POST

Author: Chris

Content-Type: application/json

Description:

Request-headers:

	Header	Value	Type	Required	Description
	Authorization		String	false	Access Token

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Body-parameters:

Parameter	Type	Required	Description
roleIds	array	false	应用角色 id
roleCodes	array	false	应用角色编号
enabled	boolean	false	是否启用

Parameter

Type

Required

Description

roleIds

array

false

应用角色 id

roleCodes

array

false

应用角色编号

enabled

boolean

false

是否启用

Request-body:

{
  "roleIds": [
    471
  ],
  "roleCodes": [
    "flyblm"
  ],
  "enabled": true
}

Response-fields:

Field	Type	Description	Since
id	int64	应用角色ID	-
code	string	应用角色编号	-
name	string	应用角色名称	-
enabled	boolean	是否启用	-

Field

Type

Description

Since

int64

应用角色ID

code

string

应用角色编号

name

string

应用角色名称

enabled

boolean

是否启用

Response-example:

[
  {
    "id": 566,
    "code": "99507",
    "name": "marg.collier",
    "enabled": true
  }
]

Curl-example:

curl -X POST -H 'Content-Type: application/json' -H 'Authorization' -i http://127.0.0.1:9010/sys/dubbo/test/role/rpc/dto --data '{
  "roleIds": [
    471
  ],
  "roleCodes": [
    "flyblm"
  ],
  "enabled": true
}'

1.3.4.

URL: http://127.0.0.1:9010/sys/dubbo/test/user/rpc/save

Type: POST

Author: Chris

Content-Type: application/json

Description:

Request-headers:

	Header	Value	Type	Required	Description
	Authorization		String	false	Access Token

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Body-parameters:

Parameter	Type	Required	Description
username	string	true	用户账号名称
password	string	false	密码
lastName	string	false	用户姓氏
firstName	string	false	用户名称
mobile	string	true	用户手机号码
email	string	false	用户邮箱地址
enabled	boolean	false	是否启用
ouId	int64	false	用户所属公司ID
ouCode	string	false	用户所属公司编号
ouName	string	false	用户所属公司名称
roleIds	array	false	功能角色ID列表
dataRoleIds	array	false	数据角色ID列表
flowRoleIds	array	false	流程角色ID列表
sourceType	string	false	账号来源, sys：系统创建；wec：微信创建；oth：其他方式
terminals	array	false	用户终端可登录的端 BACKEND APP APPLET
tenantId	int64	false	租户ID
userType	string	false	用户类型

Parameter

Type

Required

Description

username

string

true

用户账号名称

password

string

false

密码

lastName

string

false

用户姓氏

firstName

string

false

用户名称

mobile

string

true

用户手机号码

string

false

用户邮箱地址

enabled

boolean

false

是否启用

ouId

int64

false

用户所属公司ID

ouCode

string

false

用户所属公司编号

ouName

string

false

用户所属公司名称

roleIds

array

false

功能角色ID列表

dataRoleIds

array

false

数据角色ID列表

flowRoleIds

array

false

流程角色ID列表

sourceType

string

false

账号来源, sys：系统创建；wec：微信创建；oth：其他方式

terminals

array

false

用户终端
可登录的端
BACKEND
APP
APPLET

tenantId

int64

false

租户ID

userType

string

false

用户类型

Request-body:

{
  "username": "marg.collier",
  "password": "y0l9ut",
  "lastName": "marg.collier",
  "firstName": "marg.collier",
  "mobile": "(734) 208-3091",
  "email": "celinda.goldner@gmail.com",
  "enabled": true,
  "ouId": 511,
  "ouCode": "99507",
  "ouName": "marg.collier",
  "roleIds": [
    440
  ],
  "dataRoleIds": [
    544
  ],
  "flowRoleIds": [
    197
  ],
  "sourceType": "r6n8jx",
  "terminals": [
    "BACKEND"
  ],
  "tenantId": 849,
  "userType": "vlg15z"
}

Response-fields:

Field	Type	Description	Since
code	int32	响应码	-
msg	string	响应消息	-
errorMsg	string	错误信息	-
success	boolean	是否成功	-
errorNo	string	错误号	-
data	object	响应数据	-
└─any object	object	any object.	-
time	string	响应时间	-

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

└─any object

object

any object.

time

string

响应时间

Response-example:

{
  "code": 8,
  "msg": "vi34df",
  "errorMsg": "aa3lem",
  "success": true,
  "errorNo": "xgub33",
  "data": {},
  "time": "2023-02-13 08:31:53"
}

Curl-example:

curl -X POST -H 'Content-Type: application/json' -H 'Authorization' -i http://127.0.0.1:9010/sys/dubbo/test/user/rpc/save --data '{
  "username": "marg.collier",
  "password": "y0l9ut",
  "lastName": "marg.collier",
  "firstName": "marg.collier",
  "mobile": "(734) 208-3091",
  "email": "celinda.goldner@gmail.com",
  "enabled": true,
  "ouId": 511,
  "ouCode": "99507",
  "ouName": "marg.collier",
  "roleIds": [
    440
  ],
  "dataRoleIds": [
    544
  ],
  "flowRoleIds": [
    197
  ],
  "sourceType": "r6n8jx",
  "terminals": [
    "BACKEND"
  ],
  "tenantId": 849,
  "userType": "vlg15z"
}'

1.3.5.

URL: http://127.0.0.1:9010/sys/dubbo/test/log/getUserByUsername

Type: GET

Author: Chris

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description:

Request-headers:

	Header	Value	Type	Required	Description
	Authorization		String	false	Access Token

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Response-example:

string

Curl-example:

curl -X GET -H 'Authorization' -i http://127.0.0.1:9010/sys/dubbo/test/log/getUserByUsername

1.3.6.

URL: http://127.0.0.1:9010/sys/dubbo/test/user/get

Type: GET

Author: Chris

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description:

Request-headers:

	Header	Value	Type	Required	Description
	Authorization		String	false	Access Token

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Query-parameters:

	Parameter	Value	Type	Required	Description
	username		string	false	No comments found.

Parameter

Value

Type

Required

Description

username

string

false

No comments found.

Response-example:

string

Curl-example:

curl -X GET -H 'Authorization' -i http://127.0.0.1:9010/sys/dubbo/test/user/get?username=marg.collier

1.4. 功能说明

1.4.1.

URL: http://127.0.0.1:9010/sys/sysRocketMqConsumeFailLog/sendFailMessage

Type: POST

Author: roman.zhang

Content-Type: application/json

Description:

Request-headers:

	Header	Value	Type	Required	Description
	Authorization		String	false	Access Token

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Body-parameters:

Parameter	Type	Required	Description
current	int32	false	页码
size	int32	false	页大小
keyword	string	false	搜索关键字
orders	array	false	排序
└─column	string	false	属性名称
└─asc	boolean	false	是否升序
id	int64	false	记录唯一ID
typeId	int32	false	消费失败类型：1：消费次数过多，2：业务异常，3：长时间无法消费,4:其他
alreadyDeal	string	false	消费失败是否已处理；PROCESSED：已处理，TO_BE_PROCESSED:待处理
consumerKey	string	false	消息体key
consumerBoby	array	false	No comments found.
messageUuid	string	false	No comments found.
consumerGroup	string	false	消费者组
consumerTopic	string	false	消费主题
customConsumerTopic	string	false	No comments found.
consumerTag	string	false	No comments found.
messageDetail	string	false	消费数据详情
tenantId	int64	false	租户ID
remark	string	false	备注
createUserId	int64	false	记录创建者ID
creator	string	false	记录创建者
createTime	string	false	记录创建时间
modifyUserId	int64	false	记录最后更新者ID
updater	string	false	记录最后更新者
modifyTime	string	false	记录最后更新时间
deleteFlag	int32	false	逻辑删除，0：未删除，1：已删除
auditDataVersion	int32	false	锁版本
secBuId	int64	false	sec_bu_id
secUserId	int64	false	sec_user_id
secOuId	int64	false	sec_ou_id

Parameter

Type

Required

Description

current

int32

false

页码

size

int32

false

页大小

keyword

string

false

搜索关键字

orders

array

false

排序

└─column

string

false

属性名称

└─asc

boolean

false

是否升序

int64

false

记录唯一ID

typeId

int32

false

消费失败类型：1：消费次数过多，2：业务异常，3：长时间无法消费,4:其他

alreadyDeal

string

false

消费失败是否已处理；PROCESSED：已处理，TO_BE_PROCESSED:待处理

consumerKey

string

false

消息体key

consumerBoby

array

false

No comments found.

messageUuid

string

false

No comments found.

consumerGroup

string

false

消费者组

consumerTopic

string

false

消费主题

customConsumerTopic

string

false

No comments found.

consumerTag

string

false

No comments found.

messageDetail

string

false

消费数据详情

tenantId

int64

false

租户ID

remark

string

false

备注

createUserId

int64

false

记录创建者ID

creator

string

false

记录创建者

createTime

string

false

记录创建时间

modifyUserId

int64

false

记录最后更新者ID

updater

string

false

记录最后更新者

modifyTime

string

false

记录最后更新时间

deleteFlag

int32

false

逻辑删除，0：未删除，1：已删除

auditDataVersion

int32

false

锁版本

secBuId

int64

false

sec_bu_id

secUserId

int64

false

sec_user_id

secOuId

int64

false

sec_ou_id

Request-body:

{
  "current": 25,
  "size": 10,
  "keyword": "k2uxnx",
  "orders": [
    {
      "column": "7ex9xm",
      "asc": true
    }
  ],
  "id": 514,
  "typeId": 664,
  "alreadyDeal": "8exzk2",
  "consumerKey": "rcg5cv",
  "consumerBoby": [
    7
  ],
  "messageUuid": "15a735fb-c14e-4375-a6c8-185565863e12",
  "consumerGroup": "n8xjd1",
  "consumerTopic": "d25civ",
  "customConsumerTopic": "s57txb",
  "consumerTag": "tknfkt",
  "messageDetail": "c6mf6q",
  "tenantId": 72,
  "remark": "3epkm7",
  "createUserId": 228,
  "creator": "ah0i7u",
  "createTime": "2023-02-13 08:31:50",
  "modifyUserId": 622,
  "updater": "msylr5",
  "modifyTime": "2023-02-13 08:31:50",
  "deleteFlag": 9,
  "auditDataVersion": 381,
  "secBuId": 633,
  "secUserId": 752,
  "secOuId": 7
}

Response-fields:

Field	Type	Description	Since
code	int32	响应码	-
msg	string	响应消息	-
errorMsg	string	错误信息	-
success	boolean	是否成功	-
errorNo	string	错误号	-
data	object	响应数据	-
└─any object	object	any object.	-
time	string	响应时间	-

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

└─any object

object

any object.

time

string

响应时间

Response-example:

{
  "code": 409,
  "msg": "mzug5z",
  "errorMsg": "czj9yf",
  "success": true,
  "errorNo": "yyg3vb",
  "data": {},
  "time": "2023-02-13 08:31:53"
}

Curl-example:

curl -X POST -H 'Content-Type: application/json' -H 'Authorization' -i http://127.0.0.1:9010/sys/sysRocketMqConsumeFailLog/sendFailMessage --data '{
  "current": 25,
  "size": 10,
  "keyword": "k2uxnx",
  "orders": [
    {
      "column": "7ex9xm",
      "asc": true
    }
  ],
  "id": 514,
  "typeId": 664,
  "alreadyDeal": "8exzk2",
  "consumerKey": "rcg5cv",
  "consumerBoby": [
    7
  ],
  "messageUuid": "15a735fb-c14e-4375-a6c8-185565863e12",
  "consumerGroup": "n8xjd1",
  "consumerTopic": "d25civ",
  "customConsumerTopic": "s57txb",
  "consumerTag": "tknfkt",
  "messageDetail": "c6mf6q",
  "tenantId": 72,
  "remark": "3epkm7",
  "createUserId": 228,
  "creator": "ah0i7u",
  "createTime": "2023-02-13 08:31:50",
  "modifyUserId": 622,
  "updater": "msylr5",
  "modifyTime": "2023-02-13 08:31:50",
  "deleteFlag": 9,
  "auditDataVersion": 381,
  "secBuId": 633,
  "secUserId": 752,
  "secOuId": 7
}'

1.4.2. 通过主键查询单条数据

URL: http://127.0.0.1:9010/sys/sysRocketMqConsumeFailLog/findIdOne/{id}

Type: GET

Author: roman.zhang

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 通过主键查询单条数据

Request-headers:

	Header	Value	Type	Required	Description
	Authorization		String	false	Access Token

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Path-parameters:

	Parameter	Value	Type	Required	Description
	id		int64	true	主键

Parameter

Value

Type

Required

Description

int64

true

主键

Response-fields:

Field	Type	Description	Since
code	int32	响应码	-
msg	string	响应消息	-
errorMsg	string	错误信息	-
success	boolean	是否成功	-
errorNo	string	错误号	-
data	object	响应数据	-
└─id	int64	记录唯一ID	-
└─typeId	int32	消费失败类型：1：消费次数过多，2：业务异常，3：长时间无法消费,4:其他	-
└─alreadyDeal	string	消费失败是否已处理；PROCESSED：已处理，TO_BE_PROCESSED:待处理	-
└─consumerKey	string	消息体key	-
└─consumerBoby	array	No comments found.	-
└─consumerBobyString	string	No comments found.	-
└─consumerTag	string	No comments found.	-
└─consumerGroup	string	消费者组	-
└─consumerTopic	string	消费主题	-
└─messageDetail	string	消费数据详情	-
└─tenantId	int64	租户ID	-
└─remark	string	备注	-
└─createUserId	int64	记录创建者ID	-
└─creator	string	记录创建者	-
└─createTime	string	记录创建时间	-
└─modifyUserId	int64	记录最后更新者ID	-
└─updater	string	记录最后更新者	-
└─modifyTime	string	记录最后更新时间	-
└─deleteFlag	int32	逻辑删除，0：未删除，1：已删除	-
└─auditDataVersion	int32	锁版本	-
└─secBuId	int64	sec_bu_id	-
└─secUserId	int64	sec_user_id	-
└─secOuId	int64	sec_ou_id	-
time	string	响应时间	-

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

└─id

int64

记录唯一ID

└─typeId

int32

消费失败类型：1：消费次数过多，2：业务异常，3：长时间无法消费,4:其他

└─alreadyDeal

string

消费失败是否已处理；PROCESSED：已处理，TO_BE_PROCESSED:待处理

└─consumerKey

string

消息体key

└─consumerBoby

array

No comments found.

└─consumerBobyString

string

No comments found.

└─consumerTag

string

No comments found.

└─consumerGroup

string

消费者组

└─consumerTopic

string

消费主题

└─messageDetail

string

消费数据详情

└─tenantId

int64

租户ID

└─remark

string

备注

└─createUserId

int64

记录创建者ID

└─creator

string

记录创建者

└─createTime

string

记录创建时间

└─modifyUserId

int64

记录最后更新者ID

└─updater

string

记录最后更新者

└─modifyTime

string

记录最后更新时间

└─deleteFlag

int32

逻辑删除，0：未删除，1：已删除

└─auditDataVersion

int32

锁版本

└─secBuId

int64

sec_bu_id

└─secUserId

int64

sec_user_id

└─secOuId

int64

sec_ou_id

time

string

响应时间

Response-example:

{
  "code": 10,
  "msg": "eg9n1t",
  "errorMsg": "m3t1jq",
  "success": true,
  "errorNo": "gmxqoi",
  "data": {
    "id": 671,
    "typeId": 533,
    "alreadyDeal": "j3zpnb",
    "consumerKey": "m040xc",
    "consumerBoby": [
      95
    ],
    "consumerBobyString": "2sh6su",
    "consumerTag": "7y6ujo",
    "consumerGroup": "4raghm",
    "consumerTopic": "krbxxh",
    "messageDetail": "yfkf4b",
    "tenantId": 523,
    "remark": "jbc1af",
    "createUserId": 452,
    "creator": "higgkz",
    "createTime": "2023-02-13 08:31:53",
    "modifyUserId": 126,
    "updater": "z94lsh",
    "modifyTime": "2023-02-13 08:31:53",
    "deleteFlag": 9,
    "auditDataVersion": 244,
    "secBuId": 735,
    "secUserId": 287,
    "secOuId": 32
  },
  "time": "2023-02-13 08:31:53"
}

Curl-example:

curl -X GET -H 'Authorization' -i http://127.0.0.1:9010/sys/sysRocketMqConsumeFailLog/findIdOne/660

1.4.3. 根据关键字段查询数据

URL: http://127.0.0.1:9010/sys/sysRocketMqConsumeFailLog/findCodeOne/{key}

Type: GET

Author: roman.zhang

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据关键字段查询数据

Request-headers:

	Header	Value	Type	Required	Description
	Authorization		String	false	Access Token

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Path-parameters:

	Parameter	Value	Type	Required	Description
	key		string	true	参数

Parameter

Value

Type

Required

Description

key

string

true

参数

Response-fields:

Field	Type	Description	Since
code	int32	响应码	-
msg	string	响应消息	-
errorMsg	string	错误信息	-
success	boolean	是否成功	-
errorNo	string	错误号	-
data	object	响应数据	-
└─id	int64	记录唯一ID	-
└─typeId	int32	消费失败类型：1：消费次数过多，2：业务异常，3：长时间无法消费,4:其他	-
└─alreadyDeal	string	消费失败是否已处理；PROCESSED：已处理，TO_BE_PROCESSED:待处理	-
└─consumerKey	string	消息体key	-
└─consumerBoby	array	No comments found.	-
└─consumerBobyString	string	No comments found.	-
└─consumerTag	string	No comments found.	-
└─consumerGroup	string	消费者组	-
└─consumerTopic	string	消费主题	-
└─messageDetail	string	消费数据详情	-
└─tenantId	int64	租户ID	-
└─remark	string	备注	-
└─createUserId	int64	记录创建者ID	-
└─creator	string	记录创建者	-
└─createTime	string	记录创建时间	-
└─modifyUserId	int64	记录最后更新者ID	-
└─updater	string	记录最后更新者	-
└─modifyTime	string	记录最后更新时间	-
└─deleteFlag	int32	逻辑删除，0：未删除，1：已删除	-
└─auditDataVersion	int32	锁版本	-
└─secBuId	int64	sec_bu_id	-
└─secUserId	int64	sec_user_id	-
└─secOuId	int64	sec_ou_id	-
time	string	响应时间	-

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

└─id

int64

记录唯一ID

└─typeId

int32

消费失败类型：1：消费次数过多，2：业务异常，3：长时间无法消费,4:其他

└─alreadyDeal

string

消费失败是否已处理；PROCESSED：已处理，TO_BE_PROCESSED:待处理

└─consumerKey

string

消息体key

└─consumerBoby

array

No comments found.

└─consumerBobyString

string

No comments found.

└─consumerTag

string

No comments found.

└─consumerGroup

string

消费者组

└─consumerTopic

string

消费主题

└─messageDetail

string

消费数据详情

└─tenantId

int64

租户ID

└─remark

string

备注

└─createUserId

int64

记录创建者ID

└─creator

string

记录创建者

└─createTime

string

记录创建时间

└─modifyUserId

int64

记录最后更新者ID

└─updater

string

记录最后更新者

└─modifyTime

string

记录最后更新时间

└─deleteFlag

int32

逻辑删除，0：未删除，1：已删除

└─auditDataVersion

int32

锁版本

└─secBuId

int64

sec_bu_id

└─secUserId

int64

sec_user_id

└─secOuId

int64

sec_ou_id

time

string

响应时间

Response-example:

{
  "code": 353,
  "msg": "7iunk1",
  "errorMsg": "98ym6f",
  "success": true,
  "errorNo": "isxdtp",
  "data": {
    "id": 682,
    "typeId": 303,
    "alreadyDeal": "nfczvc",
    "consumerKey": "4sx4cd",
    "consumerBoby": [
      64
    ],
    "consumerBobyString": "lnrsp5",
    "consumerTag": "1uywjz",
    "consumerGroup": "ejasqe",
    "consumerTopic": "ctrl6w",
    "messageDetail": "djtcdb",
    "tenantId": 928,
    "remark": "5123iu",
    "createUserId": 787,
    "creator": "nt5ier",
    "createTime": "2023-02-13 08:31:53",
    "modifyUserId": 868,
    "updater": "1l6ncw",
    "modifyTime": "2023-02-13 08:31:53",
    "deleteFlag": 9,
    "auditDataVersion": 969,
    "secBuId": 920,
    "secUserId": 374,
    "secOuId": 462
  },
  "time": "2023-02-13 08:31:53"
}

Curl-example:

curl -X GET -H 'Authorization' -i http://127.0.0.1:9010/sys/sysRocketMqConsumeFailLog/findCodeOne/6d6cni

1.4.4. 分页查询

URL: http://127.0.0.1:9010/sys/sysRocketMqConsumeFailLog/search

Type: POST

Author: roman.zhang

Content-Type: application/json

Description: 分页查询

Request-headers:

	Header	Value	Type	Required	Description
	Authorization		String	false	Access Token

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Body-parameters:

Parameter	Type	Required	Description
current	int32	false	页码
size	int32	false	页大小
keyword	string	false	搜索关键字
orders	array	false	排序
└─column	string	false	属性名称
└─asc	boolean	false	是否升序
id	int64	false	记录唯一ID
typeId	int32	false	消费失败类型：1：消费次数过多，2：业务异常，3：长时间无法消费,4:其他
alreadyDeal	string	false	消费失败是否已处理；PROCESSED：已处理，TO_BE_PROCESSED:待处理
consumerKey	string	false	消息体key
consumerBoby	array	false	No comments found.
messageUuid	string	false	No comments found.
consumerGroup	string	false	消费者组
consumerTopic	string	false	消费主题
customConsumerTopic	string	false	No comments found.
consumerTag	string	false	No comments found.
messageDetail	string	false	消费数据详情
tenantId	int64	false	租户ID
remark	string	false	备注
createUserId	int64	false	记录创建者ID
creator	string	false	记录创建者
createTime	string	false	记录创建时间
modifyUserId	int64	false	记录最后更新者ID
updater	string	false	记录最后更新者
modifyTime	string	false	记录最后更新时间
deleteFlag	int32	false	逻辑删除，0：未删除，1：已删除
auditDataVersion	int32	false	锁版本
secBuId	int64	false	sec_bu_id
secUserId	int64	false	sec_user_id
secOuId	int64	false	sec_ou_id

Parameter

Type

Required

Description

current

int32

false

页码

size

int32

false

页大小

keyword

string

false

搜索关键字

orders

array

false

排序

└─column

string

false

属性名称

└─asc

boolean

false

是否升序

int64

false

记录唯一ID

typeId

int32

false

消费失败类型：1：消费次数过多，2：业务异常，3：长时间无法消费,4:其他

alreadyDeal

string

false

消费失败是否已处理；PROCESSED：已处理，TO_BE_PROCESSED:待处理

consumerKey

string

false

消息体key

consumerBoby

array

false

No comments found.

messageUuid

string

false

No comments found.

consumerGroup

string

false

消费者组

consumerTopic

string

false

消费主题

customConsumerTopic

string

false

No comments found.

consumerTag

string

false

No comments found.

messageDetail

string

false

消费数据详情

tenantId

int64

false

租户ID

remark

string

false

备注

createUserId

int64

false

记录创建者ID

creator

string

false

记录创建者

createTime

string

false

记录创建时间

modifyUserId

int64

false

记录最后更新者ID

updater

string

false

记录最后更新者

modifyTime

string

false

记录最后更新时间

deleteFlag

int32

false

逻辑删除，0：未删除，1：已删除

auditDataVersion

int32

false

锁版本

secBuId

int64

false

sec_bu_id

secUserId

int64

false

sec_user_id

secOuId

int64

false

sec_ou_id

Request-body:

{
  "current": 628,
  "size": 10,
  "keyword": "g25sx5",
  "orders": [
    {
      "column": "bhxmxe",
      "asc": true
    }
  ],
  "id": 568,
  "typeId": 858,
  "alreadyDeal": "gqnoei",
  "consumerKey": "mvwn0w",
  "consumerBoby": [
    85
  ],
  "messageUuid": "15a735fb-c14e-4375-a6c8-185565863e12",
  "consumerGroup": "9cuwvn",
  "consumerTopic": "gyu66h",
  "customConsumerTopic": "jvq9m9",
  "consumerTag": "7ixttz",
  "messageDetail": "at5w51",
  "tenantId": 770,
  "remark": "b2fdyc",
  "createUserId": 539,
  "creator": "84j1rk",
  "createTime": "2023-02-13 08:31:50",
  "modifyUserId": 998,
  "updater": "rv0ara",
  "modifyTime": "2023-02-13 08:31:50",
  "deleteFlag": 9,
  "auditDataVersion": 54,
  "secBuId": 749,
  "secUserId": 565,
  "secOuId": 83
}

Response-fields:

Field	Type	Description	Since
code	int32	响应码	-
msg	string	响应消息	-
errorMsg	string	错误信息	-
success	boolean	是否成功	-
errorNo	string	错误号	-
data	object	响应数据	-
└─total	int64	总记录数	-
└─records	array	数据列表	-
└─id	int64	记录唯一ID	-
└─typeId	int32	消费失败类型：1：消费次数过多，2：业务异常，3：长时间无法消费,4:其他	-
└─alreadyDeal	string	消费失败是否已处理；PROCESSED：已处理，TO_BE_PROCESSED:待处理	-
└─consumerKey	string	消息体key	-
└─consumerBoby	array	No comments found.	-
└─consumerBobyString	string	No comments found.	-
└─consumerTag	string	No comments found.	-
└─consumerGroup	string	消费者组	-
└─consumerTopic	string	消费主题	-
└─messageDetail	string	消费数据详情	-
└─tenantId	int64	租户ID	-
└─remark	string	备注	-
└─createUserId	int64	记录创建者ID	-
└─creator	string	记录创建者	-
└─createTime	string	记录创建时间	-
└─modifyUserId	int64	记录最后更新者ID	-
└─updater	string	记录最后更新者	-
└─modifyTime	string	记录最后更新时间	-
└─deleteFlag	int32	逻辑删除，0：未删除，1：已删除	-
└─auditDataVersion	int32	锁版本	-
└─secBuId	int64	sec_bu_id	-
└─secUserId	int64	sec_user_id	-
└─secOuId	int64	sec_ou_id	-
time	string	响应时间	-

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

└─total

int64

总记录数

└─records

array

数据列表

└─id

int64

记录唯一ID

└─typeId

int32

消费失败类型：1：消费次数过多，2：业务异常，3：长时间无法消费,4:其他

└─alreadyDeal

string

消费失败是否已处理；PROCESSED：已处理，TO_BE_PROCESSED:待处理

└─consumerKey

string

消息体key

└─consumerBoby

array

No comments found.

└─consumerBobyString

string

No comments found.

└─consumerTag

string

No comments found.

└─consumerGroup

string

消费者组

└─consumerTopic

string

消费主题

└─messageDetail

string

消费数据详情

└─tenantId

int64

租户ID

└─remark

string

备注

└─createUserId

int64

记录创建者ID

└─creator

string

记录创建者

└─createTime

string

记录创建时间

└─modifyUserId

int64

记录最后更新者ID

└─updater

string

记录最后更新者

└─modifyTime

string

记录最后更新时间

└─deleteFlag

int32

逻辑删除，0：未删除，1：已删除

└─auditDataVersion

int32

锁版本

└─secBuId

int64

sec_bu_id

└─secUserId

int64

sec_user_id

└─secOuId

int64

sec_ou_id

time

string

响应时间

Response-example:

{
  "code": 113,
  "msg": "9m18or",
  "errorMsg": "kdezak",
  "success": true,
  "errorNo": "fl2b7j",
  "data": {
    "total": 589,
    "records": [
      {
        "id": 640,
        "typeId": 328,
        "alreadyDeal": "vbpqtf",
        "consumerKey": "c0dtrp",
        "consumerBoby": [
          59
        ],
        "consumerBobyString": "7nvx57",
        "consumerTag": "5obcv6",
        "consumerGroup": "pv4gk1",
        "consumerTopic": "qu5tgb",
        "messageDetail": "xjwkgt",
        "tenantId": 780,
        "remark": "z7eydu",
        "createUserId": 39,
        "creator": "u3q0gu",
        "createTime": "2023-02-13 08:31:53",
        "modifyUserId": 387,
        "updater": "psv8t1",
        "modifyTime": "2023-02-13 08:31:53",
        "deleteFlag": 9,
        "auditDataVersion": 982,
        "secBuId": 256,
        "secUserId": 865,
        "secOuId": 612
      }
    ]
  },
  "time": "2023-02-13 08:31:53"
}

Curl-example:

curl -X POST -H 'Content-Type: application/json' -H 'Authorization' -i http://127.0.0.1:9010/sys/sysRocketMqConsumeFailLog/search --data '{
  "current": 628,
  "size": 10,
  "keyword": "g25sx5",
  "orders": [
    {
      "column": "bhxmxe",
      "asc": true
    }
  ],
  "id": 568,
  "typeId": 858,
  "alreadyDeal": "gqnoei",
  "consumerKey": "mvwn0w",
  "consumerBoby": [
    85
  ],
  "messageUuid": "15a735fb-c14e-4375-a6c8-185565863e12",
  "consumerGroup": "9cuwvn",
  "consumerTopic": "gyu66h",
  "customConsumerTopic": "jvq9m9",
  "consumerTag": "7ixttz",
  "messageDetail": "at5w51",
  "tenantId": 770,
  "remark": "b2fdyc",
  "createUserId": 539,
  "creator": "84j1rk",
  "createTime": "2023-02-13 08:31:50",
  "modifyUserId": 998,
  "updater": "rv0ara",
  "modifyTime": "2023-02-13 08:31:50",
  "deleteFlag": 9,
  "auditDataVersion": 54,
  "secBuId": 749,
  "secUserId": 565,
  "secOuId": 83
}'

1.4.5. 新增数据

URL: http://127.0.0.1:9010/sys/sysRocketMqConsumeFailLog/createOne

Type: POST

Author: roman.zhang

Content-Type: application/json

Description: 新增数据

Request-headers:

	Header	Value	Type	Required	Description
	Authorization		String	false	Access Token

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Body-parameters:

Parameter	Type	Required	Description
id	int64	false	记录唯一ID
typeId	int32	false	消费失败类型：1：消费次数过多，2：业务异常，3：长时间无法消费,4:其他
reconsumeTimes	int32	false	No comments found.
alreadyDeal	string	false	消费失败是否已处理；PROCESSED：已处理，TO_BE_PROCESSED:待处理
consumerKey	string	false	消息体key
consumerBoby	array	false	No comments found.
messageUuid	string	false	No comments found.
consumerGroup	string	false	消费者组
consumerTopic	string	false	消费主题
consumerTag	string	false	No comments found.
messageDetail	string	false	消费数据详情
tenantId	int64	false	租户ID
remark	string	false	备注
createUserId	int64	false	记录创建者ID
creator	string	false	记录创建者
createTime	string	false	记录创建时间
modifyUserId	int64	false	记录最后更新者ID
updater	string	false	记录最后更新者
modifyTime	string	false	记录最后更新时间
deleteFlag	int32	false	逻辑删除，0：未删除，1：已删除
auditDataVersion	int32	false	锁版本
secBuId	int64	false	sec_bu_id
secUserId	int64	false	sec_user_id
secOuId	int64	false	sec_ou_id

Parameter

Type

Required

Description

int64

false

记录唯一ID

typeId

int32

false

消费失败类型：1：消费次数过多，2：业务异常，3：长时间无法消费,4:其他

reconsumeTimes

int32

false

No comments found.

alreadyDeal

string

false

消费失败是否已处理；PROCESSED：已处理，TO_BE_PROCESSED:待处理

consumerKey

string

false

消息体key

consumerBoby

array

false

No comments found.

messageUuid

string

false

No comments found.

consumerGroup

string

false

消费者组

consumerTopic

string

false

消费主题

consumerTag

string

false

No comments found.

messageDetail

string

false

消费数据详情

tenantId

int64

false

租户ID

remark

string

false

备注

createUserId

int64

false

记录创建者ID

creator

string

false

记录创建者

createTime

string

false

记录创建时间

modifyUserId

int64

false

记录最后更新者ID

updater

string

false

记录最后更新者

modifyTime

string

false

记录最后更新时间

deleteFlag

int32

false

逻辑删除，0：未删除，1：已删除

auditDataVersion

int32

false

锁版本

secBuId

int64

false

sec_bu_id

secUserId

int64

false

sec_user_id

secOuId

int64

false

sec_ou_id

Request-body:

{
  "id": 889,
  "typeId": 504,
  "reconsumeTimes": 950,
  "alreadyDeal": "ukqufx",
  "consumerKey": "r0vm4t",
  "consumerBoby": [
    58
  ],
  "messageUuid": "15a735fb-c14e-4375-a6c8-185565863e12",
  "consumerGroup": "g7ernz",
  "consumerTopic": "cie3t7",
  "consumerTag": "47nb7t",
  "messageDetail": "pfwz8h",
  "tenantId": 455,
  "remark": "0q4fgi",
  "createUserId": 720,
  "creator": "0kzdyn",
  "createTime": "2023-02-13 08:31:50",
  "modifyUserId": 340,
  "updater": "zn43fc",
  "modifyTime": "2023-02-13 08:31:50",
  "deleteFlag": 9,
  "auditDataVersion": 303,
  "secBuId": 38,
  "secUserId": 867,
  "secOuId": 571
}

Response-fields:

Field	Type	Description	Since
code	int32	响应码	-
msg	string	响应消息	-
errorMsg	string	错误信息	-
success	boolean	是否成功	-
errorNo	string	错误号	-
data	object	响应数据	-
└─any object	object	any object.	-
time	string	响应时间	-

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

└─any object

object

any object.

time

string

响应时间

Response-example:

{
  "code": 359,
  "msg": "6mr6v6",
  "errorMsg": "p21b01",
  "success": true,
  "errorNo": "cvp4tp",
  "data": {},
  "time": "2023-02-13 08:31:53"
}

Curl-example:

curl -X POST -H 'Content-Type: application/json' -H 'Authorization' -i http://127.0.0.1:9010/sys/sysRocketMqConsumeFailLog/createOne --data '{
  "id": 889,
  "typeId": 504,
  "reconsumeTimes": 950,
  "alreadyDeal": "ukqufx",
  "consumerKey": "r0vm4t",
  "consumerBoby": [
    58
  ],
  "messageUuid": "15a735fb-c14e-4375-a6c8-185565863e12",
  "consumerGroup": "g7ernz",
  "consumerTopic": "cie3t7",
  "consumerTag": "47nb7t",
  "messageDetail": "pfwz8h",
  "tenantId": 455,
  "remark": "0q4fgi",
  "createUserId": 720,
  "creator": "0kzdyn",
  "createTime": "2023-02-13 08:31:50",
  "modifyUserId": 340,
  "updater": "zn43fc",
  "modifyTime": "2023-02-13 08:31:50",
  "deleteFlag": 9,
  "auditDataVersion": 303,
  "secBuId": 38,
  "secUserId": 867,
  "secOuId": 571
}'

1.4.6. 批量新增数据

URL: http://127.0.0.1:9010/sys/sysRocketMqConsumeFailLog/createBatch

Type: POST

Author: roman.zhang

Content-Type: application/json

Description: 批量新增数据

Request-headers:

	Header	Value	Type	Required	Description
	Authorization		String	false	Access Token

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Body-parameters:

Parameter	Type	Required	Description
id	int64	false	记录唯一ID
typeId	int32	false	消费失败类型：1：消费次数过多，2：业务异常，3：长时间无法消费,4:其他
reconsumeTimes	int32	false	No comments found.
alreadyDeal	string	false	消费失败是否已处理；PROCESSED：已处理，TO_BE_PROCESSED:待处理
consumerKey	string	false	消息体key
consumerBoby	array	false	No comments found.
messageUuid	string	false	No comments found.
consumerGroup	string	false	消费者组
consumerTopic	string	false	消费主题
consumerTag	string	false	No comments found.
messageDetail	string	false	消费数据详情
tenantId	int64	false	租户ID
remark	string	false	备注
createUserId	int64	false	记录创建者ID
creator	string	false	记录创建者
createTime	string	false	记录创建时间
modifyUserId	int64	false	记录最后更新者ID
updater	string	false	记录最后更新者
modifyTime	string	false	记录最后更新时间
deleteFlag	int32	false	逻辑删除，0：未删除，1：已删除
auditDataVersion	int32	false	锁版本
secBuId	int64	false	sec_bu_id
secUserId	int64	false	sec_user_id
secOuId	int64	false	sec_ou_id

Parameter

Type

Required

Description

int64

false

记录唯一ID

typeId

int32

false

消费失败类型：1：消费次数过多，2：业务异常，3：长时间无法消费,4:其他

reconsumeTimes

int32

false

No comments found.

alreadyDeal

string

false

消费失败是否已处理；PROCESSED：已处理，TO_BE_PROCESSED:待处理

consumerKey

string

false

消息体key

consumerBoby

array

false

No comments found.

messageUuid

string

false

No comments found.

consumerGroup

string

false

消费者组

consumerTopic

string

false

消费主题

consumerTag

string

false

No comments found.

messageDetail

string

false

消费数据详情

tenantId

int64

false

租户ID

remark

string

false

备注

createUserId

int64

false

记录创建者ID

creator

string

false

记录创建者

createTime

string

false

记录创建时间

modifyUserId

int64

false

记录最后更新者ID

updater

string

false

记录最后更新者

modifyTime

string

false

记录最后更新时间

deleteFlag

int32

false

逻辑删除，0：未删除，1：已删除

auditDataVersion

int32

false

锁版本

secBuId

int64

false

sec_bu_id

secUserId

int64

false

sec_user_id

secOuId

int64

false

sec_ou_id

Request-body:

[
  {
    "id": 247,
    "typeId": 444,
    "reconsumeTimes": 661,
    "alreadyDeal": "2yfqmz",
    "consumerKey": "skdl26",
    "consumerBoby": [
      21
    ],
    "messageUuid": "15a735fb-c14e-4375-a6c8-185565863e12",
    "consumerGroup": "zequjq",
    "consumerTopic": "ff2p6q",
    "consumerTag": "2keefd",
    "messageDetail": "v7mehe",
    "tenantId": 981,
    "remark": "q985sk",
    "createUserId": 330,
    "creator": "21c3th",
    "createTime": "2023-02-13 08:31:50",
    "modifyUserId": 291,
    "updater": "jguowx",
    "modifyTime": "2023-02-13 08:31:50",
    "deleteFlag": 9,
    "auditDataVersion": 211,
    "secBuId": 647,
    "secUserId": 162,
    "secOuId": 591
  }
]

Response-fields:

Field	Type	Description	Since
code	int32	响应码	-
msg	string	响应消息	-
errorMsg	string	错误信息	-
success	boolean	是否成功	-
errorNo	string	错误号	-
data	object	响应数据	-
└─any object	object	any object.	-
time	string	响应时间	-

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

└─any object

object

any object.

time

string

响应时间

Response-example:

{
  "code": 639,
  "msg": "iljik4",
  "errorMsg": "0fuxnd",
  "success": true,
  "errorNo": "oq44r3",
  "data": {},
  "time": "2023-02-13 08:31:53"
}

Curl-example:

curl -X POST -H 'Content-Type: application/json' -H 'Authorization' -i http://127.0.0.1:9010/sys/sysRocketMqConsumeFailLog/createBatch --data '[
  {
    "id": 247,
    "typeId": 444,
    "reconsumeTimes": 661,
    "alreadyDeal": "2yfqmz",
    "consumerKey": "skdl26",
    "consumerBoby": [
      21
    ],
    "messageUuid": "15a735fb-c14e-4375-a6c8-185565863e12",
    "consumerGroup": "zequjq",
    "consumerTopic": "ff2p6q",
    "consumerTag": "2keefd",
    "messageDetail": "v7mehe",
    "tenantId": 981,
    "remark": "q985sk",
    "createUserId": 330,
    "creator": "21c3th",
    "createTime": "2023-02-13 08:31:50",
    "modifyUserId": 291,
    "updater": "jguowx",
    "modifyTime": "2023-02-13 08:31:50",
    "deleteFlag": 9,
    "auditDataVersion": 211,
    "secBuId": 647,
    "secUserId": 162,
    "secOuId": 591
  }
]'

1.4.7. 根据主键删除数据

URL: http://127.0.0.1:9010/sys/sysRocketMqConsumeFailLog/deleteOne/{id}

Type: DELETE

Author: roman.zhang

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据主键删除数据

Request-headers:

	Header	Value	Type	Required	Description
	Authorization		String	false	Access Token

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Path-parameters:

	Parameter	Value	Type	Required	Description
	id		int64	true	主键

Parameter

Value

Type

Required

Description

int64

true

主键

Response-fields:

Field	Type	Description	Since
code	int32	响应码	-
msg	string	响应消息	-
errorMsg	string	错误信息	-
success	boolean	是否成功	-
errorNo	string	错误号	-
data	object	响应数据	-
└─any object	object	any object.	-
time	string	响应时间	-

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

└─any object

object

any object.

time

string

响应时间

Response-example:

{
  "code": 908,
  "msg": "4nj6x0",
  "errorMsg": "d2g0jz",
  "success": true,
  "errorNo": "4y6axl",
  "data": {},
  "time": "2023-02-13 08:31:53"
}

Curl-example:

curl -X DELETE -H 'Authorization' -i http://127.0.0.1:9010/sys/sysRocketMqConsumeFailLog/deleteOne/211

1.4.8. 批量删除

URL: http://127.0.0.1:9010/sys/sysRocketMqConsumeFailLog/deleteBatch

Type: DELETE

Author: roman.zhang

Content-Type: application/json

Description: 批量删除

Request-headers:

	Header	Value	Type	Required	Description
	Authorization		String	false	Access Token

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Body-parameters:

Parameter

Type

Required

Description

ids

array

false

删除数据集合,[array of int64]@since

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

└─any object

object

any object.

time

string

响应时间

Response-example:

{
  "code": 133,
  "msg": "a261rm",
  "errorMsg": "4ghh0f",
  "success": true,
  "errorNo": "ndk76g",
  "data": {},
  "time": "2023-02-13 08:31:53"
}

Curl-example:

curl -X DELETE -H 'Content-Type: application/json' -H 'Authorization' -i http://127.0.0.1:9010/sys/sysRocketMqConsumeFailLog/deleteBatch --data '[]'

1.4.9. 逻辑删除

URL: http://127.0.0.1:9010/sys/sysRocketMqConsumeFailLog/updateDeleteFlag/{id}

Type: PUT

Author: roman.zhang

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 逻辑删除

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Path-parameters:

Parameter

Value

Type

Required

Description

int64

true

更新数据

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

└─any object

object

any object.

time

string

响应时间

Response-example:

{
  "code": 701,
  "msg": "of3jjl",
  "errorMsg": "ztvyek",
  "success": true,
  "errorNo": "bv3cc3",
  "data": {},
  "time": "2023-02-13 08:31:53"
}

Curl-example:

curl -X PUT -H 'Authorization' -i http://127.0.0.1:9010/sys/sysRocketMqConsumeFailLog/updateDeleteFlag/208

1.5. 功能说明

1.5.1. 通过主键查询单条数据

URL: http://127.0.0.1:9010/sys/sysRocketMqConsumeLog/findIdOne/{id}

Type: GET

Author: roman.zhang

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 通过主键查询单条数据

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Path-parameters:

Parameter

Value

Type

Required

Description

int64

true

主键

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

└─id

int64

记录唯一ID

└─lineNum

int64

消息行号

└─consumerKey

string

消息体key

└─consumerGroup

string

消费者组

└─consumerTopic

string

消费主题

└─isSuccess

boolean

是否消费成功:true:成功，false:失败

└─failDetail

string

失败详情

└─tenantId

int64

租户ID

└─remark

string

备注

└─createUserId

int64

记录创建者ID

└─creator

string

记录创建者

└─createTime

string

记录创建时间

└─modifyUserId

int64

记录最后更新者ID

└─updater

string

记录最后更新者

└─modifyTime

string

记录最后更新时间

└─deleteFlag

int32

逻辑删除，0：未删除，1：已删除

└─auditDataVersion

int32

锁版本

└─secBuId

int64

sec_bu_id

└─secUserId

int64

sec_user_id

└─secOuId

int64

sec_ou_id

time

string

响应时间

Response-example:

{
  "code": 93,
  "msg": "a07w3j",
  "errorMsg": "0e9350",
  "success": true,
  "errorNo": "wkp7m7",
  "data": {
    "id": 429,
    "lineNum": 418,
    "consumerKey": "5i1pu3",
    "consumerGroup": "852z7q",
    "consumerTopic": "tyzmax",
    "isSuccess": true,
    "failDetail": "q6n71s",
    "tenantId": 255,
    "remark": "iivurp",
    "createUserId": 531,
    "creator": "7yrx57",
    "createTime": "2023-02-13 08:31:50",
    "modifyUserId": 980,
    "updater": "rcdahi",
    "modifyTime": "2023-02-13 08:31:50",
    "deleteFlag": 9,
    "auditDataVersion": 555,
    "secBuId": 758,
    "secUserId": 993,
    "secOuId": 599
  },
  "time": "2023-02-13 08:31:53"
}

Curl-example:

curl -X GET -H 'Authorization' -i http://127.0.0.1:9010/sys/sysRocketMqConsumeLog/findIdOne/877

1.5.2. 根据关键字段查询数据

URL: http://127.0.0.1:9010/sys/sysRocketMqConsumeLog/findCodeOne/{key}

Type: GET

Author: roman.zhang

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据关键字段查询数据

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Path-parameters:

Parameter

Value

Type

Required

Description

key

string

true

参数

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

└─id

int64

记录唯一ID

└─lineNum

int64

消息行号

└─consumerKey

string

消息体key

└─consumerGroup

string

消费者组

└─consumerTopic

string

消费主题

└─isSuccess

boolean

是否消费成功:true:成功，false:失败

└─failDetail

string

失败详情

└─tenantId

int64

租户ID

└─remark

string

备注

└─createUserId

int64

记录创建者ID

└─creator

string

记录创建者

└─createTime

string

记录创建时间

└─modifyUserId

int64

记录最后更新者ID

└─updater

string

记录最后更新者

└─modifyTime

string

记录最后更新时间

└─deleteFlag

int32

逻辑删除，0：未删除，1：已删除

└─auditDataVersion

int32

锁版本

└─secBuId

int64

sec_bu_id

└─secUserId

int64

sec_user_id

└─secOuId

int64

sec_ou_id

time

string

响应时间

Response-example:

{
  "code": 881,
  "msg": "uuqlxp",
  "errorMsg": "ru94s2",
  "success": true,
  "errorNo": "6o1t5o",
  "data": {
    "id": 972,
    "lineNum": 467,
    "consumerKey": "ryrpao",
    "consumerGroup": "ccsg2g",
    "consumerTopic": "9hkdt2",
    "isSuccess": true,
    "failDetail": "0pycq9",
    "tenantId": 998,
    "remark": "hjuuns",
    "createUserId": 533,
    "creator": "pkmslc",
    "createTime": "2023-02-13 08:31:50",
    "modifyUserId": 672,
    "updater": "ws8xz0",
    "modifyTime": "2023-02-13 08:31:50",
    "deleteFlag": 9,
    "auditDataVersion": 585,
    "secBuId": 620,
    "secUserId": 280,
    "secOuId": 667
  },
  "time": "2023-02-13 08:31:53"
}

Curl-example:

curl -X GET -H 'Authorization' -i http://127.0.0.1:9010/sys/sysRocketMqConsumeLog/findCodeOne/is06tf

1.5.3. 分页查询

URL: http://127.0.0.1:9010/sys/sysRocketMqConsumeLog/search

Type: POST

Author: roman.zhang

Content-Type: application/json

Description: 分页查询

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Body-parameters:

Parameter

Type

Required

Description

current

int32

false

页码

size

int32

false

页大小

keyword

string

false

搜索关键字

orders

array

false

排序

└─column

string

false

属性名称

└─asc

boolean

false

是否升序

int64

false

记录唯一ID

lineNum

int64

false

消息行号

queueId

int32

false

No comments found.

messageId

string

false

No comments found.

reconsumeTimes

int32

false

No comments found.

messageUuid

string

false

No comments found.

consumerKey

string

false

消息体key

consumerGroup

string

false

消费者组

consumerTopic

string

false

消费主题

isSuccess

boolean

false

是否消费成功:true:成功，false:失败

failDetail

string

false

失败详情

tenantId

int64

false

租户ID

remark

string

false

备注

createUserId

int64

false

记录创建者ID

creator

string

false

记录创建者

createTime

string

false

记录创建时间

modifyUserId

int64

false

记录最后更新者ID

updater

string

false

记录最后更新者

modifyTime

string

false

记录最后更新时间

deleteFlag

int32

false

逻辑删除，0：未删除，1：已删除

auditDataVersion

int32

false

锁版本

secBuId

int64

false

sec_bu_id

secUserId

int64

false

sec_user_id

secOuId

int64

false

sec_ou_id

Request-body:

{
  "current": 520,
  "size": 10,
  "keyword": "uk0atp",
  "orders": [
    {
      "column": "q998hp",
      "asc": true
    }
  ],
  "id": 374,
  "lineNum": 934,
  "queueId": 959,
  "messageId": "173",
  "reconsumeTimes": 683,
  "messageUuid": "15a735fb-c14e-4375-a6c8-185565863e12",
  "consumerKey": "q3308p",
  "consumerGroup": "a2ha4t",
  "consumerTopic": "d4dkzn",
  "isSuccess": true,
  "failDetail": "c5vynu",
  "tenantId": 466,
  "remark": "4pzwrr",
  "createUserId": 192,
  "creator": "24vf50",
  "createTime": "2023-02-13 08:31:50",
  "modifyUserId": 363,
  "updater": "7v3xdh",
  "modifyTime": "2023-02-13 08:31:50",
  "deleteFlag": 9,
  "auditDataVersion": 781,
  "secBuId": 684,
  "secUserId": 318,
  "secOuId": 468
}

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

└─total

int64

总记录数

└─records

array

数据列表

└─id

int64

记录唯一ID

└─lineNum

int64

消息行号

└─consumerKey

string

消息体key

└─consumerGroup

string

消费者组

└─consumerTopic

string

消费主题

└─isSuccess

boolean

是否消费成功:true:成功，false:失败

└─failDetail

string

失败详情

└─tenantId

int64

租户ID

└─remark

string

备注

└─createUserId

int64

记录创建者ID

└─creator

string

记录创建者

└─createTime

string

记录创建时间

└─modifyUserId

int64

记录最后更新者ID

└─updater

string

记录最后更新者

└─modifyTime

string

记录最后更新时间

└─deleteFlag

int32

逻辑删除，0：未删除，1：已删除

└─auditDataVersion

int32

锁版本

└─secBuId

int64

sec_bu_id

└─secUserId

int64

sec_user_id

└─secOuId

int64

sec_ou_id

time

string

响应时间

Response-example:

{
  "code": 938,
  "msg": "d1gb50",
  "errorMsg": "6lr9wz",
  "success": true,
  "errorNo": "8259ac",
  "data": {
    "total": 825,
    "records": [
      {
        "id": 790,
        "lineNum": 122,
        "consumerKey": "4lrubq",
        "consumerGroup": "5kd7t3",
        "consumerTopic": "z3s2t3",
        "isSuccess": true,
        "failDetail": "ics3o7",
        "tenantId": 71,
        "remark": "ck5u92",
        "createUserId": 901,
        "creator": "9e4n4x",
        "createTime": "2023-02-13 08:31:50",
        "modifyUserId": 316,
        "updater": "2wacvm",
        "modifyTime": "2023-02-13 08:31:50",
        "deleteFlag": 9,
        "auditDataVersion": 122,
        "secBuId": 947,
        "secUserId": 350,
        "secOuId": 105
      }
    ]
  },
  "time": "2023-02-13 08:31:53"
}

Curl-example:

curl -X POST -H 'Content-Type: application/json' -H 'Authorization' -i http://127.0.0.1:9010/sys/sysRocketMqConsumeLog/search --data '{
  "current": 520,
  "size": 10,
  "keyword": "uk0atp",
  "orders": [
    {
      "column": "q998hp",
      "asc": true
    }
  ],
  "id": 374,
  "lineNum": 934,
  "queueId": 959,
  "messageId": "173",
  "reconsumeTimes": 683,
  "messageUuid": "15a735fb-c14e-4375-a6c8-185565863e12",
  "consumerKey": "q3308p",
  "consumerGroup": "a2ha4t",
  "consumerTopic": "d4dkzn",
  "isSuccess": true,
  "failDetail": "c5vynu",
  "tenantId": 466,
  "remark": "4pzwrr",
  "createUserId": 192,
  "creator": "24vf50",
  "createTime": "2023-02-13 08:31:50",
  "modifyUserId": 363,
  "updater": "7v3xdh",
  "modifyTime": "2023-02-13 08:31:50",
  "deleteFlag": 9,
  "auditDataVersion": 781,
  "secBuId": 684,
  "secUserId": 318,
  "secOuId": 468
}'

1.5.4. 新增数据

URL: http://127.0.0.1:9010/sys/sysRocketMqConsumeLog/createOne

Type: POST

Author: roman.zhang

Content-Type: application/json

Description: 新增数据

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Body-parameters:

Parameter

Type

Required

Description

int64

false

记录唯一ID

lineNum

int64

false

消息行号

queueId

int32

false

No comments found.

messageId

string

false

No comments found.

messageUuid

string

false

No comments found.

reconsumeTimes

int32

false

No comments found.

consumerKey

string

false

消息体key

consumerGroup

string

false

消费者组

consumerTopic

string

false

消费主题

isSuccess

boolean

false

是否消费成功:true:成功，false:失败

failDetail

string

false

失败详情

tenantId

int64

false

租户ID

remark

string

false

备注

createUserId

int64

false

记录创建者ID

creator

string

false

记录创建者

createTime

string

false

记录创建时间

modifyUserId

int64

false

记录最后更新者ID

updater

string

false

记录最后更新者

modifyTime

string

false

记录最后更新时间

deleteFlag

int32

false

逻辑删除，0：未删除，1：已删除

auditDataVersion

int32

false

锁版本

secBuId

int64

false

sec_bu_id

secUserId

int64

false

sec_user_id

secOuId

int64

false

sec_ou_id

Request-body:

{
  "id": 400,
  "lineNum": 233,
  "queueId": 358,
  "messageId": "173",
  "messageUuid": "15a735fb-c14e-4375-a6c8-185565863e12",
  "reconsumeTimes": 519,
  "consumerKey": "k99atl",
  "consumerGroup": "is7b8y",
  "consumerTopic": "afjusq",
  "isSuccess": true,
  "failDetail": "c5rr4x",
  "tenantId": 53,
  "remark": "5teuyf",
  "createUserId": 284,
  "creator": "hx4jei",
  "createTime": "2023-02-13 08:31:50",
  "modifyUserId": 220,
  "updater": "fr224m",
  "modifyTime": "2023-02-13 08:31:50",
  "deleteFlag": 9,
  "auditDataVersion": 840,
  "secBuId": 497,
  "secUserId": 636,
  "secOuId": 934
}

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

└─any object

object

any object.

time

string

响应时间

Response-example:

{
  "code": 749,
  "msg": "w820kb",
  "errorMsg": "5e3nyu",
  "success": true,
  "errorNo": "p99yra",
  "data": {},
  "time": "2023-02-13 08:31:53"
}

Curl-example:

curl -X POST -H 'Content-Type: application/json' -H 'Authorization' -i http://127.0.0.1:9010/sys/sysRocketMqConsumeLog/createOne --data '{
  "id": 400,
  "lineNum": 233,
  "queueId": 358,
  "messageId": "173",
  "messageUuid": "15a735fb-c14e-4375-a6c8-185565863e12",
  "reconsumeTimes": 519,
  "consumerKey": "k99atl",
  "consumerGroup": "is7b8y",
  "consumerTopic": "afjusq",
  "isSuccess": true,
  "failDetail": "c5rr4x",
  "tenantId": 53,
  "remark": "5teuyf",
  "createUserId": 284,
  "creator": "hx4jei",
  "createTime": "2023-02-13 08:31:50",
  "modifyUserId": 220,
  "updater": "fr224m",
  "modifyTime": "2023-02-13 08:31:50",
  "deleteFlag": 9,
  "auditDataVersion": 840,
  "secBuId": 497,
  "secUserId": 636,
  "secOuId": 934
}'

1.5.5. 批量新增数据

URL: http://127.0.0.1:9010/sys/sysRocketMqConsumeLog/createBatch

Type: POST

Author: roman.zhang

Content-Type: application/json

Description: 批量新增数据

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Body-parameters:

Parameter

Type

Required

Description

int64

false

记录唯一ID

lineNum

int64

false

消息行号

queueId

int32

false

No comments found.

messageId

string

false

No comments found.

messageUuid

string

false

No comments found.

reconsumeTimes

int32

false

No comments found.

consumerKey

string

false

消息体key

consumerGroup

string

false

消费者组

consumerTopic

string

false

消费主题

isSuccess

boolean

false

是否消费成功:true:成功，false:失败

failDetail

string

false

失败详情

tenantId

int64

false

租户ID

remark

string

false

备注

createUserId

int64

false

记录创建者ID

creator

string

false

记录创建者

createTime

string

false

记录创建时间

modifyUserId

int64

false

记录最后更新者ID

updater

string

false

记录最后更新者

modifyTime

string

false

记录最后更新时间

deleteFlag

int32

false

逻辑删除，0：未删除，1：已删除

auditDataVersion

int32

false

锁版本

secBuId

int64

false

sec_bu_id

secUserId

int64

false

sec_user_id

secOuId

int64

false

sec_ou_id

Request-body:

[
  {
    "id": 438,
    "lineNum": 767,
    "queueId": 269,
    "messageId": "173",
    "messageUuid": "15a735fb-c14e-4375-a6c8-185565863e12",
    "reconsumeTimes": 858,
    "consumerKey": "1ai2ib",
    "consumerGroup": "f7xq9y",
    "consumerTopic": "ui716y",
    "isSuccess": true,
    "failDetail": "m9otg8",
    "tenantId": 256,
    "remark": "jbxhio",
    "createUserId": 859,
    "creator": "9od5rq",
    "createTime": "2023-02-13 08:31:50",
    "modifyUserId": 709,
    "updater": "tya20o",
    "modifyTime": "2023-02-13 08:31:50",
    "deleteFlag": 9,
    "auditDataVersion": 835,
    "secBuId": 945,
    "secUserId": 571,
    "secOuId": 112
  }
]

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

└─any object

object

any object.

time

string

响应时间

Response-example:

{
  "code": 377,
  "msg": "jas5uj",
  "errorMsg": "jlzjih",
  "success": true,
  "errorNo": "g0nm6d",
  "data": {},
  "time": "2023-02-13 08:31:53"
}

Curl-example:

curl -X POST -H 'Content-Type: application/json' -H 'Authorization' -i http://127.0.0.1:9010/sys/sysRocketMqConsumeLog/createBatch --data '[
  {
    "id": 438,
    "lineNum": 767,
    "queueId": 269,
    "messageId": "173",
    "messageUuid": "15a735fb-c14e-4375-a6c8-185565863e12",
    "reconsumeTimes": 858,
    "consumerKey": "1ai2ib",
    "consumerGroup": "f7xq9y",
    "consumerTopic": "ui716y",
    "isSuccess": true,
    "failDetail": "m9otg8",
    "tenantId": 256,
    "remark": "jbxhio",
    "createUserId": 859,
    "creator": "9od5rq",
    "createTime": "2023-02-13 08:31:50",
    "modifyUserId": 709,
    "updater": "tya20o",
    "modifyTime": "2023-02-13 08:31:50",
    "deleteFlag": 9,
    "auditDataVersion": 835,
    "secBuId": 945,
    "secUserId": 571,
    "secOuId": 112
  }
]'

1.5.6. 根据主键删除数据

URL: http://127.0.0.1:9010/sys/sysRocketMqConsumeLog/deleteOne/{id}

Type: DELETE

Author: roman.zhang

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据主键删除数据

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Path-parameters:

Parameter

Value

Type

Required

Description

int64

true

主键

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

└─any object

object

any object.

time

string

响应时间

Response-example:

{
  "code": 744,
  "msg": "97wgto",
  "errorMsg": "6ndoru",
  "success": true,
  "errorNo": "7splmy",
  "data": {},
  "time": "2023-02-13 08:31:53"
}

Curl-example:

curl -X DELETE -H 'Authorization' -i http://127.0.0.1:9010/sys/sysRocketMqConsumeLog/deleteOne/764

1.5.7. 批量删除

URL: http://127.0.0.1:9010/sys/sysRocketMqConsumeLog/deleteBatch

Type: DELETE

Author: roman.zhang

Content-Type: application/json

Description: 批量删除

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Body-parameters:

Parameter

Type

Required

Description

ids

array

false

删除数据集合,[array of int64]@since

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

└─any object

object

any object.

time

string

响应时间

Response-example:

{
  "code": 241,
  "msg": "63n5dn",
  "errorMsg": "mqt2j0",
  "success": true,
  "errorNo": "g5e0uf",
  "data": {},
  "time": "2023-02-13 08:31:53"
}

Curl-example:

curl -X DELETE -H 'Content-Type: application/json' -H 'Authorization' -i http://127.0.0.1:9010/sys/sysRocketMqConsumeLog/deleteBatch --data '[]'

1.5.8. 逻辑删除

URL: http://127.0.0.1:9010/sys/sysRocketMqConsumeLog/updateDeleteFlag/{id}

Type: PUT

Author: roman.zhang

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 逻辑删除

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Path-parameters:

Parameter

Value

Type

Required

Description

int64

true

更新数据

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

└─any object

object

any object.

time

string

响应时间

Response-example:

{
  "code": 897,
  "msg": "i6n5ih",
  "errorMsg": "2ltju9",
  "success": true,
  "errorNo": "eg763q",
  "data": {},
  "time": "2023-02-13 08:31:53"
}

Curl-example:

curl -X PUT -H 'Authorization' -i http://127.0.0.1:9010/sys/sysRocketMqConsumeLog/updateDeleteFlag/851

1.6. <pre>[功能说明]</pre>

1.6.1.

URL: http://127.0.0.1:9010/common/exceptions

Type: GET

Author: Michael Li

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description:

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Response-example:

Return void.

Curl-example:

curl -X GET -H 'Authorization' -i http://127.0.0.1:9010/common/exceptions

1.7.

1.7.1.

URL: http://127.0.0.1:9010/rosefinch/list

Type: POST

Author: eric.hao

Content-Type: application/json

Description:

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Body-parameters:

Parameter

Type

Required

Description

current

int32

false

页码

size

int32

false

页大小

keyword

string

false

搜索关键字

orders

array

false

排序

└─column

string

false

属性名称

└─asc

boolean

false

是否升序

logType

string

false

No comments found.

Request-body:

{
  "current": 557,
  "size": 10,
  "keyword": "0x45ig",
  "orders": [
    {
      "column": "mmgt6f",
      "asc": true
    }
  ],
  "logType": "zt4t8a"
}

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

└─total

int64

总记录数

└─records

array

数据列表

└─id

int64

No comments found.

└─logNo

string

No comments found.

└─logStatus

string

No comments found.

└─logType

string

No comments found.

└─successCount

int32

No comments found.

└─failCount

int32

No comments found.

└─totalCount

int32

No comments found.

└─createTime

string

No comments found.

└─endTime

string

No comments found.

└─details

array

No comments found.

└─id

int64

No comments found.

└─lineNo

int32

No comments found.

└─masId

int64

No comments found.

└─logStatus

string

No comments found.

└─errorMsg

string

No comments found.

└─startTime

string

No comments found.

└─endTime

string

No comments found.

time

string

响应时间

Response-example:

{
  "code": 749,
  "msg": "0v13he",
  "errorMsg": "jwiw0k",
  "success": true,
  "errorNo": "gb5rvl",
  "data": {
    "total": 668,
    "records": [
      {
        "id": 894,
        "logNo": "vv08a2",
        "logStatus": "hzfb3w",
        "logType": "l8af4h",
        "successCount": 640,
        "failCount": 303,
        "totalCount": 692,
        "createTime": "2023-02-13 08:31:53",
        "endTime": "2023-02-13 08:31:53",
        "details": [
          {
            "id": 104,
            "lineNo": 134,
            "masId": 677,
            "logStatus": "mqhvs5",
            "errorMsg": "6f537m",
            "startTime": "2023-02-13 08:31:53",
            "endTime": "2023-02-13 08:31:53"
          }
        ]
      }
    ]
  },
  "time": "2023-02-13 08:31:53"
}

Curl-example:

curl -X POST -H 'Content-Type: application/json' -H 'Authorization' -i http://127.0.0.1:9010/rosefinch/list --data '{
  "current": 557,
  "size": 10,
  "keyword": "0x45ig",
  "orders": [
    {
      "column": "mmgt6f",
      "asc": true
    }
  ],
  "logType": "zt4t8a"
}'

1.7.2.

URL: http://127.0.0.1:9010/rosefinch/detail

Type: POST

Author: eric.hao

Content-Type: application/json

Description:

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Body-parameters:

Parameter

Type

Required

Description

current

int32

false

页码

size

int32

false

页大小

keyword

string

false

搜索关键字

orders

array

false

排序

└─column

string

false

属性名称

└─asc

boolean

false

是否升序

masId

int64

true

No comments found.

logStatus

string

false

No comments found.

Request-body:

{
  "current": 537,
  "size": 10,
  "keyword": "75vkvo",
  "orders": [
    {
      "column": "t3szil",
      "asc": true
    }
  ],
  "masId": 91,
  "logStatus": "ti4gki"
}

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

└─total

int64

总记录数

└─records

array

数据列表

└─id

int64

No comments found.

└─lineNo

int32

No comments found.

└─masId

int64

No comments found.

└─logStatus

string

No comments found.

└─errorMsg

string

No comments found.

└─startTime

string

No comments found.

└─endTime

string

No comments found.

time

string

响应时间

Response-example:

{
  "code": 700,
  "msg": "0kkfoa",
  "errorMsg": "j7kt2n",
  "success": true,
  "errorNo": "h78aki",
  "data": {
    "total": 881,
    "records": [
      {
        "id": 663,
        "lineNo": 602,
        "masId": 973,
        "logStatus": "qlw57x",
        "errorMsg": "tgyyx8",
        "startTime": "2023-02-13 08:31:53",
        "endTime": "2023-02-13 08:31:53"
      }
    ]
  },
  "time": "2023-02-13 08:31:53"
}

Curl-example:

curl -X POST -H 'Content-Type: application/json' -H 'Authorization' -i http://127.0.0.1:9010/rosefinch/detail --data '{
  "current": 537,
  "size": 10,
  "keyword": "75vkvo",
  "orders": [
    {
      "column": "t3szil",
      "asc": true
    }
  ],
  "masId": 91,
  "logStatus": "ti4gki"
}'

1.8.

1.8.1.

URL: http://127.0.0.1:9010/qrcode/generate

Type: GET

Author: eric.hao

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description:

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Query-parameters:

Parameter

Value

Type

Required

Description

urlCode

string

false

No comments found.

Response-example:

Return void.

Curl-example:

curl -X GET -H 'Authorization' -i http://127.0.0.1:9010/qrcode/generate?urlCode=99507

2. 公共组件

2.1. 公共下拉组件

2.1.1. 获取全部币种

URL: http://127.0.0.1:9010/com/component/curr/list

Type: GET

Author: Chris

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 获取全部币种

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Query-parameters:

Parameter

Value

Type

Required

Description

currCodeOrName

string

false

币种编码或名称

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

array

响应数据

└─id

int64

No comments found.

└─currCode

string

No comments found.

└─currName

string

No comments found.

└─dispDecimal

int32

No comments found.

time

string

响应时间

Response-example:

{
  "code": 491,
  "msg": "dgl8a5",
  "errorMsg": "obbhnz",
  "success": true,
  "errorNo": "aq6xw5",
  "data": [
    {
      "id": 401,
      "currCode": "99507",
      "currName": "marg.collier",
      "dispDecimal": 337
    }
  ],
  "time": "2023-02-13 08:31:50"
}

Curl-example:

curl -X GET -H 'Authorization' -i http://127.0.0.1:9010/com/component/curr/list?currCodeOrName=marg.collier --data '&marg.collier'

2.1.2. 根据父ID获取子区域列表

URL: http://127.0.0.1:9010/com/component/area/pid/{pid}

Type: GET

Author: Chris

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据父ID获取子区域列表

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Path-parameters:

Parameter

Value

Type

Required

Description

pid

int64

true

父ID

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

array

响应数据

└─id

int64

No comments found.

└─areaName

string

No comments found.

└─areaCode

string

No comments found.

└─areaLevel

string

No comments found.

└─pid

int64

No comments found.

└─telHead

string

No comments found.

└─zipCode

string

No comments found.

└─isLeaf

boolean

No comments found.

└─areas

array

No comments found.

time

string

响应时间

Response-example:

{
  "code": 623,
  "msg": "ircpp3",
  "errorMsg": "qklwgu",
  "success": true,
  "errorNo": "glljmv",
  "data": [
    {
      "id": 732,
      "areaName": "marg.collier",
      "areaCode": "99507",
      "areaLevel": "rpx0k9",
      "pid": 864,
      "telHead": "94ynas",
      "zipCode": "99507",
      "isLeaf": true,
      "areas": [
        {
          "$ref": ".."
        }
      ]
    }
  ],
  "time": "2023-02-13 08:31:50"
}

Curl-example:

curl -X GET -H 'Authorization' -i http://127.0.0.1:9010/com/component/area/pid/793

2.1.3. 获取全部税率

URL: http://127.0.0.1:9010/com/component/tax/list

Type: GET

Author: Chris

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 获取全部税率

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Query-parameters:

Parameter

Value

Type

Required

Description

noName

string

false

税率编号或名称

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

array

响应数据

└─id

int64

No comments found.

└─taxRateNo

string

No comments found.

└─taxRateDesc

string

No comments found.

└─taxRateValue

object

No comments found.

└─taxRateIndex

string

No comments found.

└─taxRateIndexName

string

No comments found.

time

string

响应时间

Response-example:

{
  "code": 869,
  "msg": "vclilj",
  "errorMsg": "eji2al",
  "success": true,
  "errorNo": "rubgrn",
  "data": [
    {
      "id": 847,
      "taxRateNo": "k5vbbu",
      "taxRateDesc": "yuobxy",
      "taxRateValue": 67.95,
      "taxRateIndex": "ez0x9x",
      "taxRateIndexName": "marg.collier"
    }
  ],
  "time": "2023-02-13 08:31:50"
}

Curl-example:

curl -X GET -H 'Authorization' -i http://127.0.0.1:9010/com/component/tax/list?noName=marg.collier --data '&marg.collier'

2.1.4. 获取全部支付条款

URL: http://127.0.0.1:9010/com/component/paymentTerm/list

Type: GET

Author: Chris

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 获取全部支付条款

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Query-parameters:

Parameter

Value

Type

Required

Description

codeName

string

false

编号或名称

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

array

响应数据

└─id

int64

No comments found.

└─ptCode

string

No comments found.

└─ptName

string

No comments found.

└─days

int32

No comments found.

└─baseDayType

string

No comments found.

└─dayCalcMethod

string

No comments found.

time

string

响应时间

Response-example:

{
  "code": 604,
  "msg": "w5n2gd",
  "errorMsg": "ll2qnn",
  "success": true,
  "errorNo": "jtdqxr",
  "data": [
    {
      "id": 542,
      "ptCode": "99507",
      "ptName": "marg.collier",
      "days": 305,
      "baseDayType": "phas7v",
      "dayCalcMethod": "orf32q"
    }
  ],
  "time": "2023-02-13 08:31:50"
}

Curl-example:

curl -X GET -H 'Authorization' -i http://127.0.0.1:9010/com/component/paymentTerm/list?codeName=marg.collier --data '&marg.collier'

2.2. 税率

2.2.1. 税率查询

URL: http://127.0.0.1:9010/com/comTaxRate/q

Type: POST

Author: zhenghaiyang

Content-Type: application/json

Description: 税率查询

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Body-parameters:

Parameter

Type

Required

Description

current

int32

false

页码

size

int32

false

页大小

keyword

string

false

搜索关键字

orders

array

false

排序

└─column

string

false

属性名称

└─asc

boolean

false

是否升序

int64

false

No comments found.

taxRateNo

string

false

No comments found.

taxRateDesc

string

false

No comments found.

validFromS

string

false

No comments found.

validFromE

string

false

No comments found.

validToS

string

false

No comments found.

validToE

string

false

No comments found.

taxRateValue

float

false

No comments found.

taxRateIndex

string

false

No comments found.

Request-body:

{
  "current": 663,
  "size": 10,
  "keyword": "160fhe",
  "orders": [
    {
      "column": "kdp5wu",
      "asc": true
    }
  ],
  "id": 99,
  "taxRateNo": "ij1iqc",
  "taxRateDesc": "xmb30v",
  "validFromS": "2023-02-13 08:31:50",
  "validFromE": "2023-02-13 08:31:50",
  "validToS": "2023-02-13 08:31:50",
  "validToE": "2023-02-13 08:31:50",
  "taxRateValue": 69.30,
  "taxRateIndex": "b7ej1d"
}

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

time

string

响应时间

Response-example:

{
  "code": 723,
  "msg": "9c71vh",
  "errorMsg": "v8o21v",
  "success": true,
  "errorNo": "p37xif",
  "data": {},
  "time": "2023-02-13 08:31:50"
}

Curl-example:

curl -X POST -H 'Content-Type: application/json' -H 'Authorization' -i http://127.0.0.1:9010/com/comTaxRate/q --data '{
  "current": 663,
  "size": 10,
  "keyword": "160fhe",
  "orders": [
    {
      "column": "kdp5wu",
      "asc": true
    }
  ],
  "id": 99,
  "taxRateNo": "ij1iqc",
  "taxRateDesc": "xmb30v",
  "validFromS": "2023-02-13 08:31:50",
  "validFromE": "2023-02-13 08:31:50",
  "validToS": "2023-02-13 08:31:50",
  "validToE": "2023-02-13 08:31:50",
  "taxRateValue": 69.30,
  "taxRateIndex": "b7ej1d"
}'

2.2.2. 税率查询全部

URL: http://127.0.0.1:9010/com/comTaxRate/q2

Type: POST

Author: zhenghaiyang

Content-Type: application/json

Description: 税率查询全部

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Body-parameters:

Parameter

Type

Required

Description

current

int32

false

页码

size

int32

false

页大小

keyword

string

false

搜索关键字

orders

array

false

排序

└─column

string

false

属性名称

└─asc

boolean

false

是否升序

int64

false

No comments found.

taxRateNo

string

false

No comments found.

taxRateDesc

string

false

No comments found.

validFromS

string

false

No comments found.

validFromE

string

false

No comments found.

validToS

string

false

No comments found.

validToE

string

false

No comments found.

taxRateValue

float

false

No comments found.

taxRateIndex

string

false

No comments found.

Request-body:

{
  "current": 689,
  "size": 10,
  "keyword": "vkifay",
  "orders": [
    {
      "column": "wptds8",
      "asc": true
    }
  ],
  "id": 362,
  "taxRateNo": "z1zgnj",
  "taxRateDesc": "v1t49y",
  "validFromS": "2023-02-13 08:31:50",
  "validFromE": "2023-02-13 08:31:50",
  "validToS": "2023-02-13 08:31:50",
  "validToE": "2023-02-13 08:31:50",
  "taxRateValue": 29.22,
  "taxRateIndex": "jmijts"
}

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

time

string

响应时间

Response-example:

{
  "code": 493,
  "msg": "axeuql",
  "errorMsg": "gxy1nj",
  "success": true,
  "errorNo": "3hhmls",
  "data": {},
  "time": "2023-02-13 08:31:50"
}

Curl-example:

curl -X POST -H 'Content-Type: application/json' -H 'Authorization' -i http://127.0.0.1:9010/com/comTaxRate/q2 --data '{
  "current": 689,
  "size": 10,
  "keyword": "vkifay",
  "orders": [
    {
      "column": "wptds8",
      "asc": true
    }
  ],
  "id": 362,
  "taxRateNo": "z1zgnj",
  "taxRateDesc": "v1t49y",
  "validFromS": "2023-02-13 08:31:50",
  "validFromE": "2023-02-13 08:31:50",
  "validToS": "2023-02-13 08:31:50",
  "validToE": "2023-02-13 08:31:50",
  "taxRateValue": 29.22,
  "taxRateIndex": "jmijts"
}'

2.2.3. 根据id查询单个信息

URL: http://127.0.0.1:9010/com/comTaxRate/findOne/{id}

Type: GET

Author: zhenghaiyang

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据id查询单个信息

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Path-parameters:

Parameter

Value

Type

Required

Description

int64

true

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

time

string

响应时间

Response-example:

{
  "code": 450,
  "msg": "b5ssku",
  "errorMsg": "4n0ejg",
  "success": true,
  "errorNo": "9o8xe5",
  "data": {},
  "time": "2023-02-13 08:31:50"
}

Curl-example:

curl -X GET -H 'Authorization' -i http://127.0.0.1:9010/com/comTaxRate/findOne/728

2.2.4. 税率新增

URL: http://127.0.0.1:9010/com/comTaxRate/create

Type: POST

Author: zhenghaiyang

Content-Type: application/json

Description: 税率新增

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Body-parameters:

Parameter

Type

Required

Description

ouId

int64

false

No comments found.

taxRateNo

string

false

No comments found.

taxRateDesc

string

false

No comments found.

validFrom

string

false

No comments found.

validTo

string

false

No comments found.

taxRateValue

object

false

No comments found.

taxRateIndex

string

false

No comments found.

taxRateIndexName

string

false

No comments found.

int64

false

No comments found.

tenantId

int64

false

No comments found.

remark

string

false

No comments found.

createUserId

int64

false

No comments found.

createTime

string

false

No comments found.

modifyUserId

int64

false

No comments found.

modifyTime

string

false

No comments found.

deleteFlag

int32

false

No comments found.

auditDataVersion

int32

false

No comments found.

operUserName

string

false

操作人姓名

Request-body:

{
  "ouId": 275,
  "taxRateNo": "304km3",
  "taxRateDesc": "gky96c",
  "validFrom": "2023-02-13 08:31:50",
  "validTo": "2023-02-13 08:31:50",
  "taxRateValue": 0.82,
  "taxRateIndex": "cnu6ci",
  "taxRateIndexName": "marg.collier",
  "id": 648,
  "tenantId": 545,
  "remark": "oshr1v",
  "createUserId": 850,
  "createTime": "2023-02-13 08:31:50",
  "modifyUserId": 938,
  "modifyTime": "2023-02-13 08:31:50",
  "deleteFlag": 9,
  "auditDataVersion": 458,
  "operUserName": "marg.collier"
}

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

time

string

响应时间

Response-example:

{
  "code": 525,
  "msg": "3n052d",
  "errorMsg": "prewy4",
  "success": true,
  "errorNo": "ugvklw",
  "data": {},
  "time": "2023-02-13 08:31:50"
}

Curl-example:

curl -X POST -H 'Content-Type: application/json' -H 'Authorization' -i http://127.0.0.1:9010/com/comTaxRate/create --data '{
  "ouId": 275,
  "taxRateNo": "304km3",
  "taxRateDesc": "gky96c",
  "validFrom": "2023-02-13 08:31:50",
  "validTo": "2023-02-13 08:31:50",
  "taxRateValue": 0.82,
  "taxRateIndex": "cnu6ci",
  "taxRateIndexName": "marg.collier",
  "id": 648,
  "tenantId": 545,
  "remark": "oshr1v",
  "createUserId": 850,
  "createTime": "2023-02-13 08:31:50",
  "modifyUserId": 938,
  "modifyTime": "2023-02-13 08:31:50",
  "deleteFlag": 9,
  "auditDataVersion": 458,
  "operUserName": "marg.collier"
}'

2.2.5. 税率更新

URL: http://127.0.0.1:9010/com/comTaxRate/update

Type: PUT

Author: zhenghaiyang

Content-Type: application/json

Description: 税率更新

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Body-parameters:

Parameter

Type

Required

Description

ouId

int64

false

No comments found.

taxRateNo

string

false

No comments found.

taxRateDesc

string

false

No comments found.

validFrom

string

false

No comments found.

validTo

string

false

No comments found.

taxRateValue

object

false

No comments found.

taxRateIndex

string

false

No comments found.

taxRateIndexName

string

false

No comments found.

int64

false

No comments found.

tenantId

int64

false

No comments found.

remark

string

false

No comments found.

createUserId

int64

false

No comments found.

createTime

string

false

No comments found.

modifyUserId

int64

false

No comments found.

modifyTime

string

false

No comments found.

deleteFlag

int32

false

No comments found.

auditDataVersion

int32

false

No comments found.

operUserName

string

false

操作人姓名

Request-body:

{
  "ouId": 859,
  "taxRateNo": "8skcxi",
  "taxRateDesc": "dwt9gp",
  "validFrom": "2023-02-13 08:31:50",
  "validTo": "2023-02-13 08:31:50",
  "taxRateValue": 89.65,
  "taxRateIndex": "1ei83c",
  "taxRateIndexName": "marg.collier",
  "id": 753,
  "tenantId": 52,
  "remark": "t2547e",
  "createUserId": 471,
  "createTime": "2023-02-13 08:31:50",
  "modifyUserId": 610,
  "modifyTime": "2023-02-13 08:31:50",
  "deleteFlag": 9,
  "auditDataVersion": 923,
  "operUserName": "marg.collier"
}

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

time

string

响应时间

Response-example:

{
  "code": 838,
  "msg": "x00ynu",
  "errorMsg": "05r30n",
  "success": true,
  "errorNo": "sb19ly",
  "data": {},
  "time": "2023-02-13 08:31:50"
}

Curl-example:

curl -X PUT -H 'Content-Type: application/json' -H 'Authorization' -i http://127.0.0.1:9010/com/comTaxRate/update --data '{
  "ouId": 859,
  "taxRateNo": "8skcxi",
  "taxRateDesc": "dwt9gp",
  "validFrom": "2023-02-13 08:31:50",
  "validTo": "2023-02-13 08:31:50",
  "taxRateValue": 89.65,
  "taxRateIndex": "1ei83c",
  "taxRateIndexName": "marg.collier",
  "id": 753,
  "tenantId": 52,
  "remark": "t2547e",
  "createUserId": 471,
  "createTime": "2023-02-13 08:31:50",
  "modifyUserId": 610,
  "modifyTime": "2023-02-13 08:31:50",
  "deleteFlag": 9,
  "auditDataVersion": 923,
  "operUserName": "marg.collier"
}'

2.2.6. 税率删除

URL: http://127.0.0.1:9010/com/comTaxRate/del

Type: DELETE

Author: zhenghaiyang

Content-Type: application/json

Description: 税率删除

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Body-parameters:

Parameter

Type

Required

Description

ids

array

false

税率ID列表,[array of int64]@since

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

time

string

响应时间

Response-example:

{
  "code": 40,
  "msg": "crphl6",
  "errorMsg": "xl0spy",
  "success": true,
  "errorNo": "4el3o8",
  "data": {},
  "time": "2023-02-13 08:31:50"
}

Curl-example:

curl -X DELETE -H 'Content-Type: application/json' -H 'Authorization' -i http://127.0.0.1:9010/com/comTaxRate/del --data '[]'

2.2.7. 获取税率

URL: http://127.0.0.1:9010/com/comTaxRate/getRatio

Type: POST

Author: zhenghaiyang

Content-Type: application/json

Description: 获取税率

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Body-parameters:

Parameter

Type

Required

Description

vExr1

string

false

纳税人类型

vTxa1

string

false

No comments found.

vItm

string

false

No comments found.

vDj

string

false

No comments found.

aItm

string

false

No comments found.

Request-body:

{
  "vExr1": "lpsb3t",
  "vTxa1": "y7scpi",
  "vItm": "7eoorf",
  "vDj": "2023-02-13 08:31:50",
  "aItm": "32q4wq"
}

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

time

string

响应时间

Response-example:

{
  "code": 726,
  "msg": "7j8xj6",
  "errorMsg": "h7e6kx",
  "success": true,
  "errorNo": "6vxqku",
  "data": {},
  "time": "2023-02-13 08:31:50"
}

Curl-example:

curl -X POST -H 'Content-Type: application/json' -H 'Authorization' -i http://127.0.0.1:9010/com/comTaxRate/getRatio --data '{
  "vExr1": "lpsb3t",
  "vTxa1": "y7scpi",
  "vItm": "7eoorf",
  "vDj": "2023-02-13 08:31:50",
  "aItm": "32q4wq"
}'

2.3. 省市县接口

2.3.1. 根据父ID获取子区域列表

URL: http://127.0.0.1:9010/com/area/pid/{pid}

Type: GET

Author: Chris

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据父ID获取子区域列表

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Path-parameters:

Parameter

Value

Type

Required

Description

pid

int64

true

父ID

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

array

响应数据

└─id

int64

No comments found.

└─areaName

string

No comments found.

└─areaCode

string

No comments found.

└─areaLevel

string

No comments found.

└─pid

int64

No comments found.

└─telHead

string

No comments found.

└─zipCode

string

No comments found.

└─isLeaf

boolean

No comments found.

└─areas

array

No comments found.

time

string

响应时间

Response-example:

{
  "code": 327,
  "msg": "cucp7h",
  "errorMsg": "v9x2tc",
  "success": true,
  "errorNo": "7awj35",
  "data": [
    {
      "id": 342,
      "areaName": "marg.collier",
      "areaCode": "99507",
      "areaLevel": "znr2ex",
      "pid": 75,
      "telHead": "gh6of1",
      "zipCode": "99507",
      "isLeaf": true,
      "areas": [
        {
          "$ref": ".."
        }
      ]
    }
  ],
  "time": "2023-02-13 08:31:50"
}

Curl-example:

curl -X GET -H 'Authorization' -i http://127.0.0.1:9010/com/area/pid/670

2.3.2. 获取所有区域信息(仅限省市区)

URL: http://127.0.0.1:9010/com/area/allToCounty

Type: GET

Author: Chris

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 获取所有区域信息(仅限省市区)

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

array

响应数据

└─id

int64

No comments found.

└─areaName

string

No comments found.

└─areaCode

string

No comments found.

└─areaLevel

string

No comments found.

└─pid

int64

No comments found.

└─telHead

string

No comments found.

└─zipCode

string

No comments found.

└─isLeaf

boolean

No comments found.

└─areas

array

No comments found.

time

string

响应时间

Response-example:

{
  "code": 340,
  "msg": "bab4qa",
  "errorMsg": "uti7l7",
  "success": true,
  "errorNo": "jz6a76",
  "data": [
    {
      "id": 503,
      "areaName": "marg.collier",
      "areaCode": "99507",
      "areaLevel": "da082u",
      "pid": 453,
      "telHead": "zhs8zp",
      "zipCode": "99507",
      "isLeaf": true,
      "areas": [
        {
          "$ref": ".."
        }
      ]
    }
  ],
  "time": "2023-02-13 08:31:50"
}

Curl-example:

curl -X GET -H 'Authorization' -i http://127.0.0.1:9010/com/area/allToCounty

2.4. 区域接口

2.4.1. 模糊查询城市

URL: http://127.0.0.1:9010/com/districts/searchCity/{cityName}

Type: GET

Author: Mir

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 模糊查询城市, 并带出省, 国家信息

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Path-parameters:

Parameter

Value

Type

Required

Description

cityName

string

true

城市名称

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

time

string

响应时间

Response-example:

{
  "code": 372,
  "msg": "xzpvn2",
  "errorMsg": "nkacm0",
  "success": true,
  "errorNo": "2oq08m",
  "data": {},
  "time": "2023-02-13 08:31:50"
}

Curl-example:

curl -X GET -H 'Authorization' -i http://127.0.0.1:9010/com/districts/searchCity/marg.collier

2.4.2. 查询区域

URL: http://127.0.0.1:9010/com/districts/q

Type: POST

Author: Mir

Content-Type: application/json

Description: 查询区域

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Body-parameters:

Parameter

Type

Required

Description

current

int32

false

页码

size

int32

false

页大小

keyword

string

false

搜索关键字

orders

array

false

排序

└─column

string

false

属性名称

└─asc

boolean

false

是否升序

distCode

string

false

No comments found.

distName

string

false

No comments found.

distName2

string

false

No comments found.

distType

string

false

No comments found.

distType2

string

false

No comments found.

distType3

string

false

No comments found.

abbrName

string

false

No comments found.

country

string

false

No comments found.

province

string

false

No comments found.

city

string

false

No comments found.

county

string

false

No comments found.

street

string

false

No comments found.

distLevel

string

false

No comments found.

distLevelNum

int32

false

No comments found.

parentId

int64

false

No comments found.

pCode

string

false

No comments found.

path

string

false

No comments found.

distStatus

string

false

No comments found.

distPinyin

string

false

No comments found.

distPinyinCaps

string

false

No comments found.

telHead

string

false

No comments found.

zipCode

string

false

No comments found.

distDesc

string

false

No comments found.

Request-body:

{
  "current": 690,
  "size": 10,
  "keyword": "cxohio",
  "orders": [
    {
      "column": "7vq0s3",
      "asc": true
    }
  ],
  "distCode": "99507",
  "distName": "marg.collier",
  "distName2": "ph1hg0",
  "distType": "akphx6",
  "distType2": "qci34i",
  "distType3": "opmr1t",
  "abbrName": "marg.collier",
  "country": "fu6wrg",
  "province": "gl9nkz",
  "city": "e0xjeh",
  "county": "rwkc0n",
  "street": "knr9hd",
  "distLevel": "ycujhb",
  "distLevelNum": 552,
  "parentId": 808,
  "pCode": "99507",
  "path": "2antgb",
  "distStatus": "gaqmjk",
  "distPinyin": "g16wm3",
  "distPinyinCaps": "enma2c",
  "telHead": "gdyzxf",
  "zipCode": "99507",
  "distDesc": "zho4kf"
}

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

time

string

响应时间

Response-example:

{
  "code": 728,
  "msg": "1wzem7",
  "errorMsg": "1hkvce",
  "success": true,
  "errorNo": "yj0k7r",
  "data": {},
  "time": "2023-02-13 08:31:50"
}

Curl-example:

curl -X POST -H 'Content-Type: application/json' -H 'Authorization' -i http://127.0.0.1:9010/com/districts/q --data '{
  "current": 690,
  "size": 10,
  "keyword": "cxohio",
  "orders": [
    {
      "column": "7vq0s3",
      "asc": true
    }
  ],
  "distCode": "99507",
  "distName": "marg.collier",
  "distName2": "ph1hg0",
  "distType": "akphx6",
  "distType2": "qci34i",
  "distType3": "opmr1t",
  "abbrName": "marg.collier",
  "country": "fu6wrg",
  "province": "gl9nkz",
  "city": "e0xjeh",
  "county": "rwkc0n",
  "street": "knr9hd",
  "distLevel": "ycujhb",
  "distLevelNum": 552,
  "parentId": 808,
  "pCode": "99507",
  "path": "2antgb",
  "distStatus": "gaqmjk",
  "distPinyin": "g16wm3",
  "distPinyinCaps": "enma2c",
  "telHead": "gdyzxf",
  "zipCode": "99507",
  "distDesc": "zho4kf"
}'

2.4.3. 根据父级ID列出子区域

URL: http://127.0.0.1:9010/com/districts/byparent/{pid}

Type: GET

Author: Mir

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据父级ID，列出所有的子区域

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Path-parameters:

Parameter

Value

Type

Required

Description

pid

int64

true

父级ID

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

time

string

响应时间

Response-example:

{
  "code": 577,
  "msg": "8djuu6",
  "errorMsg": "rzsibp",
  "success": true,
  "errorNo": "3awgm0",
  "data": {},
  "time": "2023-02-13 08:31:50"
}

Curl-example:

curl -X GET -H 'Authorization' -i http://127.0.0.1:9010/com/districts/byparent/613

2.4.4. 根据父级编码列出子区域

URL: http://127.0.0.1:9010/com/districts/bypcode/{pcode}

Type: GET

Author: Mir

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据父级编码，返回子区域的下拉列表

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Path-parameters:

Parameter

Value

Type

Required

Description

pcode

string

true

父级编码

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

time

string

响应时间

Response-example:

{
  "code": 282,
  "msg": "wp5hzg",
  "errorMsg": "9fkjlj",
  "success": true,
  "errorNo": "3k5iwb",
  "data": {},
  "time": "2023-02-13 08:31:50"
}

Curl-example:

curl -X GET -H 'Authorization' -i http://127.0.0.1:9010/com/districts/bypcode/99507

2.4.5. 所有国家

URL: http://127.0.0.1:9010/com/districts/bypcode/country

Type: GET

Author: Mir

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 返回国家下拉列表

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

time

string

响应时间

Response-example:

{
  "code": 33,
  "msg": "ltk6qh",
  "errorMsg": "og1lho",
  "success": true,
  "errorNo": "g4l39j",
  "data": {},
  "time": "2023-02-13 08:31:50"
}

Curl-example:

curl -X GET -H 'Authorization' -i http://127.0.0.1:9010/com/districts/bypcode/country

2.4.6. 根据区域层级返回区域

URL: http://127.0.0.1:9010/com/districts/byDistLevelNum/{distLevelNum}

Type: GET

Author: Mir

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据区域层级返回区域

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Path-parameters:

Parameter

Value

Type

Required

Description

distLevelNum

int32

true

区域层级

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

time

string

响应时间

Response-example:

{
  "code": 983,
  "msg": "sfi3x7",
  "errorMsg": "ia19rb",
  "success": true,
  "errorNo": "bxgvrw",
  "data": {},
  "time": "2023-02-13 08:31:50"
}

Curl-example:

curl -X GET -H 'Authorization' -i http://127.0.0.1:9010/com/districts/byDistLevelNum/302

2.4.7. 根据区域ID返回区域明细

URL: http://127.0.0.1:9010/com/districts/{id}

Type: GET

Author: Mir

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据区域ID返回区域明细

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Path-parameters:

Parameter

Value

Type

Required

Description

int64

true

区域ID

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

time

string

响应时间

Response-example:

{
  "code": 869,
  "msg": "h7qkyu",
  "errorMsg": "w0f1zi",
  "success": true,
  "errorNo": "zp0a5t",
  "data": {},
  "time": "2023-02-13 08:31:50"
}

Curl-example:

curl -X GET -H 'Authorization' -i http://127.0.0.1:9010/com/districts/772

2.4.8. 创建区域

URL: http://127.0.0.1:9010/com/districts/

Type: POST

Author: Mir

Content-Type: application/json

Description: 创建区域

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Body-parameters:

Parameter

Type

Required

Description

int64

false

No comments found.

distCode

string

false

No comments found.

distName

string

false

No comments found.

distName2

string

false

No comments found.

distType

string

false

No comments found.

distType2

string

false

No comments found.

distType3

string

false

No comments found.

abbrName

string

false

No comments found.

country

string

false

No comments found.

countryName

string

false

No comments found.

countryId

int64

false

No comments found.

province

string

false

No comments found.

provinceName

string

false

No comments found.

provinceId

int64

false

No comments found.

city

string

false

No comments found.

cityName

string

false

No comments found.

cityId

int64

false

No comments found.

county

string

false

No comments found.

street

string

false

No comments found.

distLevel

string

false

No comments found.

distLevelNum

int32

false

No comments found.

parentId

int64

false

No comments found.

parentCode

string

false

No comments found.

path

string

false

No comments found.

distStatus

string

false

No comments found.

distPinyin

string

false

No comments found.

distPinyinCaps

string

false

No comments found.

telHead

string

false

No comments found.

zipCode

string

false

No comments found.

distDesc

string

false

No comments found.

tenantId

int64

false

No comments found.

remark

string

false

No comments found.

createUserId

int64

false

No comments found.

createTime

string

false

No comments found.

modifyUserId

int64

false

No comments found.

modifyTime

string

false

No comments found.

deleteFlag

int32

false

No comments found.

auditDataVersion

int32

false

No comments found.

operUserName

string

false

操作人姓名

Request-body:

{
  "id": 641,
  "distCode": "99507",
  "distName": "marg.collier",
  "distName2": "lles5j",
  "distType": "7q9jo5",
  "distType2": "iarhad",
  "distType3": "fz6ydd",
  "abbrName": "marg.collier",
  "country": "hcjnvw",
  "countryName": "marg.collier",
  "countryId": 544,
  "province": "pbz9av",
  "provinceName": "marg.collier",
  "provinceId": 776,
  "city": "i7z1nu",
  "cityName": "marg.collier",
  "cityId": 767,
  "county": "jhjgsz",
  "street": "c2hm2w",
  "distLevel": "1276sg",
  "distLevelNum": 165,
  "parentId": 931,
  "parentCode": "99507",
  "path": "guk7lp",
  "distStatus": "tlsegi",
  "distPinyin": "p5vv0q",
  "distPinyinCaps": "4ax5ii",
  "telHead": "v9w78u",
  "zipCode": "99507",
  "distDesc": "y6d9fs",
  "tenantId": 954,
  "remark": "gsbr7n",
  "createUserId": 444,
  "createTime": "2023-02-13 08:31:50",
  "modifyUserId": 137,
  "modifyTime": "2023-02-13 08:31:50",
  "deleteFlag": 9,
  "auditDataVersion": 839,
  "operUserName": "marg.collier"
}

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

time

string

响应时间

Response-example:

{
  "code": 366,
  "msg": "n217nb",
  "errorMsg": "a1a3p0",
  "success": true,
  "errorNo": "w6ekn9",
  "data": {},
  "time": "2023-02-13 08:31:50"
}

Curl-example:

curl -X POST -H 'Content-Type: application/json' -H 'Authorization' -i http://127.0.0.1:9010/com/districts/ --data '{
  "id": 641,
  "distCode": "99507",
  "distName": "marg.collier",
  "distName2": "lles5j",
  "distType": "7q9jo5",
  "distType2": "iarhad",
  "distType3": "fz6ydd",
  "abbrName": "marg.collier",
  "country": "hcjnvw",
  "countryName": "marg.collier",
  "countryId": 544,
  "province": "pbz9av",
  "provinceName": "marg.collier",
  "provinceId": 776,
  "city": "i7z1nu",
  "cityName": "marg.collier",
  "cityId": 767,
  "county": "jhjgsz",
  "street": "c2hm2w",
  "distLevel": "1276sg",
  "distLevelNum": 165,
  "parentId": 931,
  "parentCode": "99507",
  "path": "guk7lp",
  "distStatus": "tlsegi",
  "distPinyin": "p5vv0q",
  "distPinyinCaps": "4ax5ii",
  "telHead": "v9w78u",
  "zipCode": "99507",
  "distDesc": "y6d9fs",
  "tenantId": 954,
  "remark": "gsbr7n",
  "createUserId": 444,
  "createTime": "2023-02-13 08:31:50",
  "modifyUserId": 137,
  "modifyTime": "2023-02-13 08:31:50",
  "deleteFlag": 9,
  "auditDataVersion": 839,
  "operUserName": "marg.collier"
}'

2.4.9. 更新区域信息

URL: http://127.0.0.1:9010/com/districts/

Type: PUT

Author: Mir

Content-Type: application/json

Description: 更新区域信息

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Body-parameters:

Parameter

Type

Required

Description

int64

false

No comments found.

distCode

string

false

No comments found.

distName

string

false

No comments found.

distName2

string

false

No comments found.

distType

string

false

No comments found.

distType2

string

false

No comments found.

distType3

string

false

No comments found.

abbrName

string

false

No comments found.

country

string

false

No comments found.

countryName

string

false

No comments found.

countryId

int64

false

No comments found.

province

string

false

No comments found.

provinceName

string

false

No comments found.

provinceId

int64

false

No comments found.

city

string

false

No comments found.

cityName

string

false

No comments found.

cityId

int64

false

No comments found.

county

string

false

No comments found.

street

string

false

No comments found.

distLevel

string

false

No comments found.

distLevelNum

int32

false

No comments found.

parentId

int64

false

No comments found.

parentCode

string

false

No comments found.

path

string

false

No comments found.

distStatus

string

false

No comments found.

distPinyin

string

false

No comments found.

distPinyinCaps

string

false

No comments found.

telHead

string

false

No comments found.

zipCode

string

false

No comments found.

distDesc

string

false

No comments found.

tenantId

int64

false

No comments found.

remark

string

false

No comments found.

createUserId

int64

false

No comments found.

createTime

string

false

No comments found.

modifyUserId

int64

false

No comments found.

modifyTime

string

false

No comments found.

deleteFlag

int32

false

No comments found.

auditDataVersion

int32

false

No comments found.

operUserName

string

false

操作人姓名

Request-body:

{
  "id": 114,
  "distCode": "99507",
  "distName": "marg.collier",
  "distName2": "s5cyld",
  "distType": "uvib39",
  "distType2": "30lr7o",
  "distType3": "hil43u",
  "abbrName": "marg.collier",
  "country": "7o7jsg",
  "countryName": "marg.collier",
  "countryId": 857,
  "province": "yovus3",
  "provinceName": "marg.collier",
  "provinceId": 471,
  "city": "3r3e3j",
  "cityName": "marg.collier",
  "cityId": 904,
  "county": "8xnki0",
  "street": "4pbh9f",
  "distLevel": "e99jcm",
  "distLevelNum": 452,
  "parentId": 941,
  "parentCode": "99507",
  "path": "wyn9ca",
  "distStatus": "1zo9nj",
  "distPinyin": "ownx0j",
  "distPinyinCaps": "incx3h",
  "telHead": "mxlv2h",
  "zipCode": "99507",
  "distDesc": "84lkd0",
  "tenantId": 593,
  "remark": "pxy3gz",
  "createUserId": 35,
  "createTime": "2023-02-13 08:31:50",
  "modifyUserId": 251,
  "modifyTime": "2023-02-13 08:31:50",
  "deleteFlag": 9,
  "auditDataVersion": 570,
  "operUserName": "marg.collier"
}

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

time

string

响应时间

Response-example:

{
  "code": 178,
  "msg": "ezq4st",
  "errorMsg": "of7sjq",
  "success": true,
  "errorNo": "pfgzrw",
  "data": {},
  "time": "2023-02-13 08:31:50"
}

Curl-example:

curl -X PUT -H 'Content-Type: application/json' -H 'Authorization' -i http://127.0.0.1:9010/com/districts/ --data '{
  "id": 114,
  "distCode": "99507",
  "distName": "marg.collier",
  "distName2": "s5cyld",
  "distType": "uvib39",
  "distType2": "30lr7o",
  "distType3": "hil43u",
  "abbrName": "marg.collier",
  "country": "7o7jsg",
  "countryName": "marg.collier",
  "countryId": 857,
  "province": "yovus3",
  "provinceName": "marg.collier",
  "provinceId": 471,
  "city": "3r3e3j",
  "cityName": "marg.collier",
  "cityId": 904,
  "county": "8xnki0",
  "street": "4pbh9f",
  "distLevel": "e99jcm",
  "distLevelNum": 452,
  "parentId": 941,
  "parentCode": "99507",
  "path": "wyn9ca",
  "distStatus": "1zo9nj",
  "distPinyin": "ownx0j",
  "distPinyinCaps": "incx3h",
  "telHead": "mxlv2h",
  "zipCode": "99507",
  "distDesc": "84lkd0",
  "tenantId": 593,
  "remark": "pxy3gz",
  "createUserId": 35,
  "createTime": "2023-02-13 08:31:50",
  "modifyUserId": 251,
  "modifyTime": "2023-02-13 08:31:50",
  "deleteFlag": 9,
  "auditDataVersion": 570,
  "operUserName": "marg.collier"
}'

2.4.10. 根据区域ID删除区域信息

URL: http://127.0.0.1:9010/com/districts/{id}

Type: DELETE

Author: Mir

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据区域ID删除区域信息

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Path-parameters:

Parameter

Value

Type

Required

Description

int64

true

区域ID

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

time

string

响应时间

Response-example:

{
  "code": 34,
  "msg": "nwi40y",
  "errorMsg": "vswegf",
  "success": true,
  "errorNo": "9uubjs",
  "data": {},
  "time": "2023-02-13 08:31:50"
}

Curl-example:

curl -X DELETE -H 'Authorization' -i http://127.0.0.1:9010/com/districts/515

2.5. 币种

2.5.1. 获取全部币种列表

URL: http://127.0.0.1:9010/com/comCurr/all

Type: GET

Author: lq

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 获取全部币种列表

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

array

响应数据

└─id

int64

No comments found.

└─currCode

string

No comments found.

└─currName

string

No comments found.

└─dispDecimal

int32

No comments found.

time

string

响应时间

Response-example:

{
  "code": 738,
  "msg": "20z4yf",
  "errorMsg": "msc4sj",
  "success": true,
  "errorNo": "vyr01y",
  "data": [
    {
      "id": 817,
      "currCode": "99507",
      "currName": "marg.collier",
      "dispDecimal": 185
    }
  ],
  "time": "2023-02-13 08:31:50"
}

Curl-example:

curl -X GET -H 'Authorization' -i http://127.0.0.1:9010/com/comCurr/all

2.5.2. 货币列表

URL: http://127.0.0.1:9010/com/comCurr/q

Type: POST

Author: lq

Content-Type: application/json

Description: 货币列表

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Body-parameters:

Parameter

Type

Required

Description

current

int32

false

页码

size

int32

false

页大小

keyword

string

false

搜索关键字

orders

array

false

排序

└─column

string

false

属性名称

└─asc

boolean

false

是否升序

currCode

string

false

No comments found.

currName

string

false

No comments found.

dispDecimal

int32

false

No comments found.

Request-body:

{
  "current": 213,
  "size": 10,
  "keyword": "uhqnn5",
  "orders": [
    {
      "column": "yoefbh",
      "asc": true
    }
  ],
  "currCode": "99507",
  "currName": "marg.collier",
  "dispDecimal": 557
}

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

time

string

响应时间

Response-example:

{
  "code": 273,
  "msg": "z01yzt",
  "errorMsg": "9xvium",
  "success": true,
  "errorNo": "hz2ahj",
  "data": {},
  "time": "2023-02-13 08:31:50"
}

Curl-example:

curl -X POST -H 'Content-Type: application/json' -H 'Authorization' -i http://127.0.0.1:9010/com/comCurr/q --data '{
  "current": 213,
  "size": 10,
  "keyword": "uhqnn5",
  "orders": [
    {
      "column": "yoefbh",
      "asc": true
    }
  ],
  "currCode": "99507",
  "currName": "marg.collier",
  "dispDecimal": 557
}'

2.5.3. 创建货币

URL: http://127.0.0.1:9010/com/comCurr/

Type: POST

Author: lq

Content-Type: application/json

Description: 创建货币

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Body-parameters:

Parameter

Type

Required

Description

currCode

string

false

No comments found.

currName

string

false

No comments found.

dispDecimal

int32

false

No comments found.

enableFlag

int32

false

No comments found.

int64

false

No comments found.

tenantId

int64

false

No comments found.

remark

string

false

No comments found.

createUserId

int64

false

No comments found.

createTime

string

false

No comments found.

modifyUserId

int64

false

No comments found.

modifyTime

string

false

No comments found.

deleteFlag

int32

false

No comments found.

auditDataVersion

int32

false

No comments found.

operUserName

string

false

操作人姓名

Request-body:

{
  "currCode": "99507",
  "currName": "marg.collier",
  "dispDecimal": 308,
  "enableFlag": 9,
  "id": 90,
  "tenantId": 189,
  "remark": "bklabn",
  "createUserId": 147,
  "createTime": "2023-02-13 08:31:50",
  "modifyUserId": 738,
  "modifyTime": "2023-02-13 08:31:50",
  "deleteFlag": 9,
  "auditDataVersion": 890,
  "operUserName": "marg.collier"
}

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

time

string

响应时间

Response-example:

{
  "code": 539,
  "msg": "rc6d0k",
  "errorMsg": "ewpfec",
  "success": true,
  "errorNo": "8hs4dm",
  "data": {},
  "time": "2023-02-13 08:31:50"
}

Curl-example:

curl -X POST -H 'Content-Type: application/json' -H 'Authorization' -i http://127.0.0.1:9010/com/comCurr/ --data '{
  "currCode": "99507",
  "currName": "marg.collier",
  "dispDecimal": 308,
  "enableFlag": 9,
  "id": 90,
  "tenantId": 189,
  "remark": "bklabn",
  "createUserId": 147,
  "createTime": "2023-02-13 08:31:50",
  "modifyUserId": 738,
  "modifyTime": "2023-02-13 08:31:50",
  "deleteFlag": 9,
  "auditDataVersion": 890,
  "operUserName": "marg.collier"
}'

2.5.4. 批量创建货币

URL: http://127.0.0.1:9010/com/comCurr/createBatch

Type: POST

Author: lq

Content-Type: application/json

Description: 批量创建货币

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Body-parameters:

Parameter

Type

Required

Description

currCode

string

false

No comments found.

currName

string

false

No comments found.

dispDecimal

int32

false

No comments found.

enableFlag

int32

false

No comments found.

int64

false

No comments found.

tenantId

int64

false

No comments found.

remark

string

false

No comments found.

createUserId

int64

false

No comments found.

createTime

string

false

No comments found.

modifyUserId

int64

false

No comments found.

modifyTime

string

false

No comments found.

deleteFlag

int32

false

No comments found.

auditDataVersion

int32

false

No comments found.

operUserName

string

false

操作人姓名

Request-body:

[
  {
    "currCode": "99507",
    "currName": "marg.collier",
    "dispDecimal": 577,
    "enableFlag": 9,
    "id": 200,
    "tenantId": 103,
    "remark": "v5q7ei",
    "createUserId": 767,
    "createTime": "2023-02-13 08:31:50",
    "modifyUserId": 157,
    "modifyTime": "2023-02-13 08:31:50",
    "deleteFlag": 9,
    "auditDataVersion": 90,
    "operUserName": "marg.collier"
  }
]

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

time

string

响应时间

Response-example:

{
  "code": 317,
  "msg": "yuyj1q",
  "errorMsg": "5iqos4",
  "success": true,
  "errorNo": "rvwlnz",
  "data": {},
  "time": "2023-02-13 08:31:50"
}

Curl-example:

curl -X POST -H 'Content-Type: application/json' -H 'Authorization' -i http://127.0.0.1:9010/com/comCurr/createBatch --data '[
  {
    "currCode": "99507",
    "currName": "marg.collier",
    "dispDecimal": 577,
    "enableFlag": 9,
    "id": 200,
    "tenantId": 103,
    "remark": "v5q7ei",
    "createUserId": 767,
    "createTime": "2023-02-13 08:31:50",
    "modifyUserId": 157,
    "modifyTime": "2023-02-13 08:31:50",
    "deleteFlag": 9,
    "auditDataVersion": 90,
    "operUserName": "marg.collier"
  }
]'

2.5.5. 更新货币

URL: http://127.0.0.1:9010/com/comCurr/

Type: PUT

Author: lq

Content-Type: application/json

Description: 更新货币

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Body-parameters:

Parameter

Type

Required

Description

currCode

string

false

No comments found.

currName

string

false

No comments found.

dispDecimal

int32

false

No comments found.

enableFlag

int32

false

No comments found.

int64

false

No comments found.

tenantId

int64

false

No comments found.

remark

string

false

No comments found.

createUserId

int64

false

No comments found.

createTime

string

false

No comments found.

modifyUserId

int64

false

No comments found.

modifyTime

string

false

No comments found.

deleteFlag

int32

false

No comments found.

auditDataVersion

int32

false

No comments found.

operUserName

string

false

操作人姓名

Request-body:

{
  "currCode": "99507",
  "currName": "marg.collier",
  "dispDecimal": 665,
  "enableFlag": 9,
  "id": 68,
  "tenantId": 972,
  "remark": "dn6xze",
  "createUserId": 114,
  "createTime": "2023-02-13 08:31:50",
  "modifyUserId": 539,
  "modifyTime": "2023-02-13 08:31:50",
  "deleteFlag": 9,
  "auditDataVersion": 37,
  "operUserName": "marg.collier"
}

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

time

string

响应时间

Response-example:

{
  "code": 73,
  "msg": "nfr2rk",
  "errorMsg": "003c5a",
  "success": true,
  "errorNo": "4gsoeg",
  "data": {},
  "time": "2023-02-13 08:31:50"
}

Curl-example:

curl -X PUT -H 'Content-Type: application/json' -H 'Authorization' -i http://127.0.0.1:9010/com/comCurr/ --data '{
  "currCode": "99507",
  "currName": "marg.collier",
  "dispDecimal": 665,
  "enableFlag": 9,
  "id": 68,
  "tenantId": 972,
  "remark": "dn6xze",
  "createUserId": 114,
  "createTime": "2023-02-13 08:31:50",
  "modifyUserId": 539,
  "modifyTime": "2023-02-13 08:31:50",
  "deleteFlag": 9,
  "auditDataVersion": 37,
  "operUserName": "marg.collier"
}'

2.5.6. 删除货币

URL: http://127.0.0.1:9010/com/comCurr/{id}

Type: DELETE

Author: lq

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 删除货币

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Path-parameters:

Parameter

Value

Type

Required

Description

int64

true

货币ID

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

time

string

响应时间

Response-example:

{
  "code": 556,
  "msg": "l5hs7h",
  "errorMsg": "qipav0",
  "success": true,
  "errorNo": "2fwg6j",
  "data": {},
  "time": "2023-02-13 08:31:50"
}

Curl-example:

curl -X DELETE -H 'Authorization' -i http://127.0.0.1:9010/com/comCurr/916

2.5.7. 批量删除货币

URL: http://127.0.0.1:9010/com/comCurr/deleteBatch/{ids}

Type: DELETE

Author: lq

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 批量删除货币

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Path-parameters:

Parameter

Value

Type

Required

Description

ids

array

true

货币ID,[array of int64]

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

time

string

响应时间

Response-example:

{
  "code": 861,
  "msg": "qwys3i",
  "errorMsg": "lnl6hj",
  "success": true,
  "errorNo": "tjlmpw",
  "data": {},
  "time": "2023-02-13 08:31:50"
}

Curl-example:

curl -X DELETE -H 'Authorization' -i http://127.0.0.1:9010/com/comCurr/deleteBatch/776,122

2.5.8. 更新删除标志

URL: http://127.0.0.1:9010/com/comCurr/updateDeleteFlag/{id}

Type: PATCH

Author: lq

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 更新删除标志

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Path-parameters:

Parameter

Value

Type

Required

Description

int64

true

货币ID

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

time

string

响应时间

Response-example:

{
  "code": 810,
  "msg": "712oi0",
  "errorMsg": "c7tk78",
  "success": true,
  "errorNo": "h094cz",
  "data": {},
  "time": "2023-02-13 08:31:50"
}

Curl-example:

curl -X PATCH -H 'Authorization' -i http://127.0.0.1:9010/com/comCurr/updateDeleteFlag/171

2.6. 支付条款

2.6.1. 列出所有的付款条款

URL: http://127.0.0.1:9010/com/comPaymentTerm/list

Type: GET

Author: shihao.ma

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 列出所有的付款条款

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

time

string

响应时间

Response-example:

{
  "code": 45,
  "msg": "dr90d7",
  "errorMsg": "w0h5v3",
  "success": true,
  "errorNo": "hksa4j",
  "data": {},
  "time": "2023-02-13 08:31:50"
}

Curl-example:

curl -X GET -H 'Authorization' -i http://127.0.0.1:9010/com/comPaymentTerm/list

2.6.2. 保存支付条款

URL: http://127.0.0.1:9010/com/comPaymentTerm/createOne

Type: POST

Author: shihao.ma

Content-Type: application/json

Description: 保存支付条款

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Body-parameters:

Parameter

Type

Required

Description

ptCode

string

false

No comments found.

ptName

string

false

No comments found.

days

int32

false

No comments found.

baseDayType

string

false

No comments found.

dayCalcMethod

string

false

No comments found.

validFrom

string

false

No comments found.

validTo

string

false

No comments found.

enableFlag

int32

false

No comments found.

accountCode

string

false

No comments found.

int64

false

No comments found.

tenantId

int64

false

No comments found.

remark

string

false

No comments found.

createUserId

int64

false

No comments found.

createTime

string

false

No comments found.

modifyUserId

int64

false

No comments found.

modifyTime

string

false

No comments found.

deleteFlag

int32

false

No comments found.

auditDataVersion

int32

false

No comments found.

operUserName

string

false

操作人姓名

Request-body:

{
  "ptCode": "99507",
  "ptName": "marg.collier",
  "days": 140,
  "baseDayType": "y9mdim",
  "dayCalcMethod": "mibgb3",
  "validFrom": "2023-02-13 08:31:50",
  "validTo": "2023-02-13 08:31:50",
  "enableFlag": 9,
  "accountCode": "99507",
  "id": 276,
  "tenantId": 379,
  "remark": "uaqdgo",
  "createUserId": 254,
  "createTime": "2023-02-13 08:31:50",
  "modifyUserId": 368,
  "modifyTime": "2023-02-13 08:31:50",
  "deleteFlag": 9,
  "auditDataVersion": 283,
  "operUserName": "marg.collier"
}

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

time

string

响应时间

Response-example:

{
  "code": 954,
  "msg": "1xbfmm",
  "errorMsg": "zr3yo4",
  "success": true,
  "errorNo": "8ywf49",
  "data": {},
  "time": "2023-02-13 08:31:50"
}

Curl-example:

curl -X POST -H 'Content-Type: application/json' -H 'Authorization' -i http://127.0.0.1:9010/com/comPaymentTerm/createOne --data '{
  "ptCode": "99507",
  "ptName": "marg.collier",
  "days": 140,
  "baseDayType": "y9mdim",
  "dayCalcMethod": "mibgb3",
  "validFrom": "2023-02-13 08:31:50",
  "validTo": "2023-02-13 08:31:50",
  "enableFlag": 9,
  "accountCode": "99507",
  "id": 276,
  "tenantId": 379,
  "remark": "uaqdgo",
  "createUserId": 254,
  "createTime": "2023-02-13 08:31:50",
  "modifyUserId": 368,
  "modifyTime": "2023-02-13 08:31:50",
  "deleteFlag": 9,
  "auditDataVersion": 283,
  "operUserName": "marg.collier"
}'

2.6.3. 批量保存支付条款

URL: http://127.0.0.1:9010/com/comPaymentTerm/createBatch

Type: POST

Author: shihao.ma

Content-Type: application/json

Description: 批量保存支付条款

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Body-parameters:

Parameter

Type

Required

Description

ptCode

string

false

No comments found.

ptName

string

false

No comments found.

days

int32

false

No comments found.

baseDayType

string

false

No comments found.

dayCalcMethod

string

false

No comments found.

validFrom

string

false

No comments found.

validTo

string

false

No comments found.

enableFlag

int32

false

No comments found.

accountCode

string

false

No comments found.

int64

false

No comments found.

tenantId

int64

false

No comments found.

remark

string

false

No comments found.

createUserId

int64

false

No comments found.

createTime

string

false

No comments found.

modifyUserId

int64

false

No comments found.

modifyTime

string

false

No comments found.

deleteFlag

int32

false

No comments found.

auditDataVersion

int32

false

No comments found.

operUserName

string

false

操作人姓名

Request-body:

[
  {
    "ptCode": "99507",
    "ptName": "marg.collier",
    "days": 385,
    "baseDayType": "yrk0p7",
    "dayCalcMethod": "02uzj7",
    "validFrom": "2023-02-13 08:31:50",
    "validTo": "2023-02-13 08:31:50",
    "enableFlag": 9,
    "accountCode": "99507",
    "id": 456,
    "tenantId": 341,
    "remark": "hghmu6",
    "createUserId": 874,
    "createTime": "2023-02-13 08:31:50",
    "modifyUserId": 536,
    "modifyTime": "2023-02-13 08:31:50",
    "deleteFlag": 9,
    "auditDataVersion": 722,
    "operUserName": "marg.collier"
  }
]

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

time

string

响应时间

Response-example:

{
  "code": 698,
  "msg": "51qhgo",
  "errorMsg": "5bfxtv",
  "success": true,
  "errorNo": "6xatl3",
  "data": {},
  "time": "2023-02-13 08:31:50"
}

Curl-example:

curl -X POST -H 'Content-Type: application/json' -H 'Authorization' -i http://127.0.0.1:9010/com/comPaymentTerm/createBatch --data '[
  {
    "ptCode": "99507",
    "ptName": "marg.collier",
    "days": 385,
    "baseDayType": "yrk0p7",
    "dayCalcMethod": "02uzj7",
    "validFrom": "2023-02-13 08:31:50",
    "validTo": "2023-02-13 08:31:50",
    "enableFlag": 9,
    "accountCode": "99507",
    "id": 456,
    "tenantId": 341,
    "remark": "hghmu6",
    "createUserId": 874,
    "createTime": "2023-02-13 08:31:50",
    "modifyUserId": 536,
    "modifyTime": "2023-02-13 08:31:50",
    "deleteFlag": 9,
    "auditDataVersion": 722,
    "operUserName": "marg.collier"
  }
]'

2.6.4. 更新支付条款

URL: http://127.0.0.1:9010/com/comPaymentTerm/update/{paymentTermId}

Type: PUT

Author: shihao.ma

Content-Type: application/json

Description: 更新支付条款

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Path-parameters:

Parameter

Value

Type

Required

Description

paymentTermId

int64

true

记录ID

Body-parameters:

Parameter

Type

Required

Description

ptCode

string

false

No comments found.

ptName

string

false

No comments found.

days

int32

false

No comments found.

baseDayType

string

false

No comments found.

dayCalcMethod

string

false

No comments found.

validFrom

string

false

No comments found.

validTo

string

false

No comments found.

enableFlag

int32

false

No comments found.

accountCode

string

false

No comments found.

int64

false

No comments found.

tenantId

int64

false

No comments found.

remark

string

false

No comments found.

createUserId

int64

false

No comments found.

createTime

string

false

No comments found.

modifyUserId

int64

false

No comments found.

modifyTime

string

false

No comments found.

deleteFlag

int32

false

No comments found.

auditDataVersion

int32

false

No comments found.

operUserName

string

false

操作人姓名

Request-body:

{
  "ptCode": "99507",
  "ptName": "marg.collier",
  "days": 759,
  "baseDayType": "kdzp4x",
  "dayCalcMethod": "weuk6m",
  "validFrom": "2023-02-13 08:31:50",
  "validTo": "2023-02-13 08:31:50",
  "enableFlag": 9,
  "accountCode": "99507",
  "id": 792,
  "tenantId": 865,
  "remark": "e105o0",
  "createUserId": 768,
  "createTime": "2023-02-13 08:31:50",
  "modifyUserId": 39,
  "modifyTime": "2023-02-13 08:31:50",
  "deleteFlag": 9,
  "auditDataVersion": 82,
  "operUserName": "marg.collier"
}

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

time

string

响应时间

Response-example:

{
  "code": 252,
  "msg": "vynpwa",
  "errorMsg": "dieasn",
  "success": true,
  "errorNo": "5c85nk",
  "data": {},
  "time": "2023-02-13 08:31:50"
}

Curl-example:

curl -X PUT -H 'Content-Type: application/json' -H 'Authorization' -i http://127.0.0.1:9010/com/comPaymentTerm/update/20 --data '{
  "ptCode": "99507",
  "ptName": "marg.collier",
  "days": 759,
  "baseDayType": "kdzp4x",
  "dayCalcMethod": "weuk6m",
  "validFrom": "2023-02-13 08:31:50",
  "validTo": "2023-02-13 08:31:50",
  "enableFlag": 9,
  "accountCode": "99507",
  "id": 792,
  "tenantId": 865,
  "remark": "e105o0",
  "createUserId": 768,
  "createTime": "2023-02-13 08:31:50",
  "modifyUserId": 39,
  "modifyTime": "2023-02-13 08:31:50",
  "deleteFlag": 9,
  "auditDataVersion": 82,
  "operUserName": "marg.collier"
}'

2.6.5. 根据ID查询支付条款

URL: http://127.0.0.1:9010/com/comPaymentTerm/findIdBatch

Type: POST

Author: shihao.ma

Content-Type: application/json

Description: 根据ID查询支付条款

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Body-parameters:

Parameter

Type

Required

Description

paymentTermIdList

array

false

支付条款ID,[array of string]@since

Request-body:

[]

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

time

string

响应时间

Response-example:

{
  "code": 915,
  "msg": "z22hlj",
  "errorMsg": "lnhu4o",
  "success": true,
  "errorNo": "t88ixt",
  "data": {},
  "time": "2023-02-13 08:31:50"
}

Curl-example:

curl -X POST -H 'Content-Type: application/json' -H 'Authorization' -i http://127.0.0.1:9010/com/comPaymentTerm/findIdBatch --data '[]'

2.6.6. 根据ID查询支付条款

URL: http://127.0.0.1:9010/com/comPaymentTerm/findIdOne/{paymentTermId}

Type: POST

Author: shihao.ma

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据ID查询支付条款

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Path-parameters:

Parameter

Value

Type

Required

Description

paymentTermId

string

true

支付条款ID

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

time

string

响应时间

Response-example:

{
  "code": 142,
  "msg": "xkpgt9",
  "errorMsg": "9w052g",
  "success": true,
  "errorNo": "k7819y",
  "data": {},
  "time": "2023-02-13 08:31:50"
}

Curl-example:

curl -X POST -H 'Authorization' -i http://127.0.0.1:9010/com/comPaymentTerm/findIdOne/173

2.6.7. 根据Code查询支付条款

URL: http://127.0.0.1:9010/com/comPaymentTerm/findCodeOne/{paymentTermCode}

Type: POST

Author: shihao.ma

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据Code查询支付条款

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Path-parameters:

Parameter

Value

Type

Required

Description

paymentTermCode

string

true

支付条款code

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

time

string

响应时间

Response-example:

{
  "code": 509,
  "msg": "p8wqj0",
  "errorMsg": "vwbz37",
  "success": true,
  "errorNo": "k8dbjc",
  "data": {},
  "time": "2023-02-13 08:31:50"
}

Curl-example:

curl -X POST -H 'Authorization' -i http://127.0.0.1:9010/com/comPaymentTerm/findCodeOne/99507

2.6.8. 分页查询支付条款

URL: http://127.0.0.1:9010/com/comPaymentTerm/search

Type: POST

Author: shihao.ma

Content-Type: application/json

Description: 分页查询支付条款

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Body-parameters:

Parameter

Type

Required

Description

current

int32

false

页码

size

int32

false

页大小

keyword

string

false

搜索关键字

orders

array

false

排序

└─column

string

false

属性名称

└─asc

boolean

false

是否升序

ptCode

string

false

No comments found.

ptName

string

false

No comments found.

days

int32

false

No comments found.

baseDayType

string

false

No comments found.

dayCalcMethod

string

false

No comments found.

validFrom

string

false

No comments found.

validTo

string

false

No comments found.

enableFlag

int32

false

No comments found.

accountCode

string

false

No comments found.

int64

false

No comments found.

tenantId

int64

false

No comments found.

remark

string

false

No comments found.

createUserId

int64

false

No comments found.

createTime

string

false

No comments found.

modifyUserId

int64

false

No comments found.

modifyTime

string

false

No comments found.

deleteFlag

int32

false

No comments found.

auditDataVersion

int32

false

No comments found.

operUserName

string

false

操作人姓名

Request-body:

{
  "current": 349,
  "size": 10,
  "keyword": "phrfnb",
  "orders": [
    {
      "column": "95z647",
      "asc": true
    }
  ],
  "ptCode": "99507",
  "ptName": "marg.collier",
  "days": 49,
  "baseDayType": "4np82t",
  "dayCalcMethod": "9gvu4m",
  "validFrom": "2023-02-13 08:31:50",
  "validTo": "2023-02-13 08:31:50",
  "enableFlag": 9,
  "accountCode": "99507",
  "id": 655,
  "tenantId": 474,
  "remark": "57v982",
  "createUserId": 129,
  "createTime": "2023-02-13 08:31:50",
  "modifyUserId": 33,
  "modifyTime": "2023-02-13 08:31:50",
  "deleteFlag": 9,
  "auditDataVersion": 229,
  "operUserName": "marg.collier"
}

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

time

string

响应时间

Response-example:

{
  "code": 365,
  "msg": "u1w1i4",
  "errorMsg": "bolevc",
  "success": true,
  "errorNo": "zy5weq",
  "data": {},
  "time": "2023-02-13 08:31:51"
}

Curl-example:

curl -X POST -H 'Content-Type: application/json' -H 'Authorization' -i http://127.0.0.1:9010/com/comPaymentTerm/search --data '{
  "current": 349,
  "size": 10,
  "keyword": "phrfnb",
  "orders": [
    {
      "column": "95z647",
      "asc": true
    }
  ],
  "ptCode": "99507",
  "ptName": "marg.collier",
  "days": 49,
  "baseDayType": "4np82t",
  "dayCalcMethod": "9gvu4m",
  "validFrom": "2023-02-13 08:31:50",
  "validTo": "2023-02-13 08:31:50",
  "enableFlag": 9,
  "accountCode": "99507",
  "id": 655,
  "tenantId": 474,
  "remark": "57v982",
  "createUserId": 129,
  "createTime": "2023-02-13 08:31:50",
  "modifyUserId": 33,
  "modifyTime": "2023-02-13 08:31:50",
  "deleteFlag": 9,
  "auditDataVersion": 229,
  "operUserName": "marg.collier"
}'

2.6.9. 删除支付条款

URL: http://127.0.0.1:9010/com/comPaymentTerm/deleteOne

Type: DELETE

Author: shihao.ma

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 删除支付条款

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Query-parameters:

Parameter

Value

Type

Required

Description

paymentTermId

int64

false

支付条款ID

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

time

string

响应时间

Response-example:

{
  "code": 461,
  "msg": "8ozocc",
  "errorMsg": "b0qiur",
  "success": true,
  "errorNo": "ng51r2",
  "data": {},
  "time": "2023-02-13 08:31:51"
}

Curl-example:

curl -X DELETE -H 'Authorization' -i http://127.0.0.1:9010/com/comPaymentTerm/deleteOne?paymentTermId=5

2.6.10. 批量删除支付条款

URL: http://127.0.0.1:9010/com/comPaymentTerm/deleteBatch

Type: DELETE

Author: shihao.ma

Content-Type: application/json

Description: 批量删除支付条款

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Body-parameters:

Parameter

Type

Required

Description

paymentTermIdList

array

false

字符条款ID,[array of string]@since

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

time

string

响应时间

Response-example:

{
  "code": 160,
  "msg": "gb4v7q",
  "errorMsg": "9u9saj",
  "success": true,
  "errorNo": "tz8nj8",
  "data": {},
  "time": "2023-02-13 08:31:51"
}

Curl-example:

curl -X DELETE -H 'Content-Type: application/json' -H 'Authorization' -i http://127.0.0.1:9010/com/comPaymentTerm/deleteBatch --data '[]'

2.6.11. 更新支付条款删除标识

URL: http://127.0.0.1:9010/com/comPaymentTerm/updateDeleteFlag

Type: POST

Author: shihao.ma

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 更新支付条款删除标识

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Query-parameters:

Parameter

Value

Type

Required

Description

string

false

字符条款ID

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

time

string

响应时间

Response-example:

{
  "code": 698,
  "msg": "0239a9",
  "errorMsg": "sxjaf0",
  "success": true,
  "errorNo": "54ap7h",
  "data": {},
  "time": "2023-02-13 08:31:51"
}

Curl-example:

curl -X POST -H 'Authorization' -i http://127.0.0.1:9010/com/comPaymentTerm/updateDeleteFlag --data 'id=173'

2.7. 汇率

2.7.1. 查询汇率

URL: http://127.0.0.1:9010/com/comCurrRate/findCurrRatio

Type: POST

Author: ssy

Content-Type: application/json

Description: 查询汇率

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Body-parameters:

Parameter

Type

Required

Description

current

int32

false

页码

size

int32

false

页大小

keyword

string

false

搜索关键字

orders

array

false

排序

└─column

string

false

属性名称

└─asc

boolean

false

是否升序

fromCurr

string

false

No comments found.

toCurr

string

false

No comments found.

validDate

string

false

有效时间

validFromS

string

false

20201110 金小康 start

validFromE

string

false

No comments found.

validToS

string

false

No comments found.

validToE

string

false

No comments found.

Request-body:

{
  "current": 963,
  "size": 10,
  "keyword": "aaagwi",
  "orders": [
    {
      "column": "2ubwg2",
      "asc": true
    }
  ],
  "fromCurr": "q3vm71",
  "toCurr": "rkwqx6",
  "validDate": "2023-02-13 08:31:51",
  "validFromS": "2023-02-13 08:31:51",
  "validFromE": "2023-02-13 08:31:51",
  "validToS": "2023-02-13 08:31:51",
  "validToE": "2023-02-13 08:31:51"
}

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

time

string

响应时间

Response-example:

{
  "code": 24,
  "msg": "xhuqz4",
  "errorMsg": "5m5369",
  "success": true,
  "errorNo": "16fxga",
  "data": {},
  "time": "2023-02-13 08:31:51"
}

Curl-example:

curl -X POST -H 'Content-Type: application/json' -H 'Authorization' -i http://127.0.0.1:9010/com/comCurrRate/findCurrRatio --data '{
  "current": 963,
  "size": 10,
  "keyword": "aaagwi",
  "orders": [
    {
      "column": "2ubwg2",
      "asc": true
    }
  ],
  "fromCurr": "q3vm71",
  "toCurr": "rkwqx6",
  "validDate": "2023-02-13 08:31:51",
  "validFromS": "2023-02-13 08:31:51",
  "validFromE": "2023-02-13 08:31:51",
  "validToS": "2023-02-13 08:31:51",
  "validToE": "2023-02-13 08:31:51"
}'

2.7.2. 查询汇率列表

URL: http://127.0.0.1:9010/com/comCurrRate/q

Type: POST

Author: ssy

Content-Type: application/json

Description: 查询汇率列表

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Body-parameters:

Parameter

Type

Required

Description

current

int32

false

页码

size

int32

false

页大小

keyword

string

false

搜索关键字

orders

array

false

排序

└─column

string

false

属性名称

└─asc

boolean

false

是否升序

fromCurr

string

false

No comments found.

toCurr

string

false

No comments found.

validDate

string

false

有效时间

validFromS

string

false

20201110 金小康 start

validFromE

string

false

No comments found.

validToS

string

false

No comments found.

validToE

string

false

No comments found.

Request-body:

{
  "current": 278,
  "size": 10,
  "keyword": "axycsn",
  "orders": [
    {
      "column": "wjwcxc",
      "asc": true
    }
  ],
  "fromCurr": "dgyals",
  "toCurr": "o9b15f",
  "validDate": "2023-02-13 08:31:51",
  "validFromS": "2023-02-13 08:31:51",
  "validFromE": "2023-02-13 08:31:51",
  "validToS": "2023-02-13 08:31:51",
  "validToE": "2023-02-13 08:31:51"
}

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

└─any object

object

any object.

time

string

响应时间

Response-example:

{
  "code": 711,
  "msg": "1v2p98",
  "errorMsg": "q6yqdm",
  "success": true,
  "errorNo": "n93a53",
  "data": {},
  "time": "2023-02-13 08:31:51"
}

Curl-example:

curl -X POST -H 'Content-Type: application/json' -H 'Authorization' -i http://127.0.0.1:9010/com/comCurrRate/q --data '{
  "current": 278,
  "size": 10,
  "keyword": "axycsn",
  "orders": [
    {
      "column": "wjwcxc",
      "asc": true
    }
  ],
  "fromCurr": "dgyals",
  "toCurr": "o9b15f",
  "validDate": "2023-02-13 08:31:51",
  "validFromS": "2023-02-13 08:31:51",
  "validFromE": "2023-02-13 08:31:51",
  "validToS": "2023-02-13 08:31:51",
  "validToE": "2023-02-13 08:31:51"
}'

2.7.3. 根据ID查询单个汇率

URL: http://127.0.0.1:9010/com/comCurrRate/findIdOne/{id}

Type: GET

Author: ssy

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据ID查询单个汇率

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Path-parameters:

Parameter

Value

Type

Required

Description

int64

true

汇率ID

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

└─any object

object

any object.

time

string

响应时间

Response-example:

{
  "code": 186,
  "msg": "07mdj4",
  "errorMsg": "sw7uu4",
  "success": true,
  "errorNo": "iitq3v",
  "data": {},
  "time": "2023-02-13 08:31:51"
}

Curl-example:

curl -X GET -H 'Authorization' -i http://127.0.0.1:9010/com/comCurrRate/findIdOne/214

2.7.4. 创建汇率

URL: http://127.0.0.1:9010/com/comCurrRate/

Type: POST

Author: ssy

Content-Type: application/json

Description: 创建汇率

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Body-parameters:

Parameter

Type

Required

Description

int64

false

记录唯一ID

tenantId

int64

false

租户ID

remark

string

false

备注

createUserId

int64

false

记录创建者ID

creator

string

false

记录创建者

createTime

string

false

记录创建时间

modifyUserId

int64

false

记录最后更新者ID

updater

string

false

记录最后更新者

modifyTime

string

false

记录最后更新时间

deleteFlag

int32

false

逻辑删除标识

auditDataVersion

int32

false

锁版本

ouId

int64

false

No comments found.

rateType

string

false

No comments found.

rateType2

string

false

No comments found.

rateType3

string

false

No comments found.

rateStatus

string

false

No comments found.

rateStatus2

string

false

No comments found.

rateSource

string

false

No comments found.

fromCurr

string

false

No comments found.

toCurr

string

false

No comments found.

calMethod

string

false

No comments found.

ratio

float

false

No comments found.

ratio2

float

false

No comments found.

ratio3

float

false

No comments found.

validFrom

string

false

No comments found.

validTo

string

false

No comments found.

periodId

int32

false

No comments found.

fromCurrName

string

false

No comments found.

toCurrName

string

false

No comments found.

Request-body:

{
  "id": 72,
  "tenantId": 23,
  "remark": "085gaj",
  "createUserId": 229,
  "creator": "bwwlaz",
  "createTime": "2023-02-13 08:31:51",
  "modifyUserId": 141,
  "updater": "vvfk2k",
  "modifyTime": "2023-02-13 08:31:51",
  "deleteFlag": 9,
  "auditDataVersion": 94,
  "ouId": 519,
  "rateType": "kvdqwh",
  "rateType2": "ezktol",
  "rateType3": "hknj6y",
  "rateStatus": "vh658a",
  "rateStatus2": "knluw2",
  "rateSource": "d6knxo",
  "fromCurr": "h7tw16",
  "toCurr": "69jekj",
  "calMethod": "qkqt9v",
  "ratio": 51.87,
  "ratio2": 82.34,
  "ratio3": 27.66,
  "validFrom": "2023-02-13 08:31:51",
  "validTo": "2023-02-13 08:31:51",
  "periodId": 521,
  "fromCurrName": "marg.collier",
  "toCurrName": "marg.collier"
}

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

└─any object

object

any object.

time

string

响应时间

Response-example:

{
  "code": 35,
  "msg": "s5wwbk",
  "errorMsg": "4is4r4",
  "success": true,
  "errorNo": "ql36au",
  "data": {},
  "time": "2023-02-13 08:31:51"
}

Curl-example:

curl -X POST -H 'Content-Type: application/json' -H 'Authorization' -i http://127.0.0.1:9010/com/comCurrRate/ --data '{
  "id": 72,
  "tenantId": 23,
  "remark": "085gaj",
  "createUserId": 229,
  "creator": "bwwlaz",
  "createTime": "2023-02-13 08:31:51",
  "modifyUserId": 141,
  "updater": "vvfk2k",
  "modifyTime": "2023-02-13 08:31:51",
  "deleteFlag": 9,
  "auditDataVersion": 94,
  "ouId": 519,
  "rateType": "kvdqwh",
  "rateType2": "ezktol",
  "rateType3": "hknj6y",
  "rateStatus": "vh658a",
  "rateStatus2": "knluw2",
  "rateSource": "d6knxo",
  "fromCurr": "h7tw16",
  "toCurr": "69jekj",
  "calMethod": "qkqt9v",
  "ratio": 51.87,
  "ratio2": 82.34,
  "ratio3": 27.66,
  "validFrom": "2023-02-13 08:31:51",
  "validTo": "2023-02-13 08:31:51",
  "periodId": 521,
  "fromCurrName": "marg.collier",
  "toCurrName": "marg.collier"
}'

2.7.5. 批量创建汇率

URL: http://127.0.0.1:9010/com/comCurrRate/createBatch

Type: POST

Author: ssy

Content-Type: application/json

Description: 批量创建汇率

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Body-parameters:

Parameter

Type

Required

Description

int64

false

记录唯一ID

tenantId

int64

false

租户ID

remark

string

false

备注

createUserId

int64

false

记录创建者ID

creator

string

false

记录创建者

createTime

string

false

记录创建时间

modifyUserId

int64

false

记录最后更新者ID

updater

string

false

记录最后更新者

modifyTime

string

false

记录最后更新时间

deleteFlag

int32

false

逻辑删除标识

auditDataVersion

int32

false

锁版本

ouId

int64

false

No comments found.

rateType

string

false

No comments found.

rateType2

string

false

No comments found.

rateType3

string

false

No comments found.

rateStatus

string

false

No comments found.

rateStatus2

string

false

No comments found.

rateSource

string

false

No comments found.

fromCurr

string

false

No comments found.

toCurr

string

false

No comments found.

calMethod

string

false

No comments found.

ratio

float

false

No comments found.

ratio2

float

false

No comments found.

ratio3

float

false

No comments found.

validFrom

string

false

No comments found.

validTo

string

false

No comments found.

periodId

int32

false

No comments found.

fromCurrName

string

false

No comments found.

toCurrName

string

false

No comments found.

Request-body:

[
  {
    "id": 302,
    "tenantId": 137,
    "remark": "uxxolz",
    "createUserId": 192,
    "creator": "7di8hz",
    "createTime": "2023-02-13 08:31:51",
    "modifyUserId": 743,
    "updater": "z0zbse",
    "modifyTime": "2023-02-13 08:31:51",
    "deleteFlag": 9,
    "auditDataVersion": 971,
    "ouId": 438,
    "rateType": "l6xv22",
    "rateType2": "31wqi8",
    "rateType3": "1ne6zb",
    "rateStatus": "p0dg3r",
    "rateStatus2": "o4y249",
    "rateSource": "5mzbdg",
    "fromCurr": "r3q9b5",
    "toCurr": "1koufo",
    "calMethod": "usywbc",
    "ratio": 65.58,
    "ratio2": 39.57,
    "ratio3": 53.22,
    "validFrom": "2023-02-13 08:31:51",
    "validTo": "2023-02-13 08:31:51",
    "periodId": 254,
    "fromCurrName": "marg.collier",
    "toCurrName": "marg.collier"
  }
]

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

└─any object

object

any object.

time

string

响应时间

Response-example:

{
  "code": 787,
  "msg": "vmq68c",
  "errorMsg": "mmtrc5",
  "success": true,
  "errorNo": "khm8va",
  "data": {},
  "time": "2023-02-13 08:31:51"
}

Curl-example:

curl -X POST -H 'Content-Type: application/json' -H 'Authorization' -i http://127.0.0.1:9010/com/comCurrRate/createBatch --data '[
  {
    "id": 302,
    "tenantId": 137,
    "remark": "uxxolz",
    "createUserId": 192,
    "creator": "7di8hz",
    "createTime": "2023-02-13 08:31:51",
    "modifyUserId": 743,
    "updater": "z0zbse",
    "modifyTime": "2023-02-13 08:31:51",
    "deleteFlag": 9,
    "auditDataVersion": 971,
    "ouId": 438,
    "rateType": "l6xv22",
    "rateType2": "31wqi8",
    "rateType3": "1ne6zb",
    "rateStatus": "p0dg3r",
    "rateStatus2": "o4y249",
    "rateSource": "5mzbdg",
    "fromCurr": "r3q9b5",
    "toCurr": "1koufo",
    "calMethod": "usywbc",
    "ratio": 65.58,
    "ratio2": 39.57,
    "ratio3": 53.22,
    "validFrom": "2023-02-13 08:31:51",
    "validTo": "2023-02-13 08:31:51",
    "periodId": 254,
    "fromCurrName": "marg.collier",
    "toCurrName": "marg.collier"
  }
]'

2.7.6. 更新汇率

URL: http://127.0.0.1:9010/com/comCurrRate/

Type: PUT

Author: ssy

Content-Type: application/json

Description: 更新汇率

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Body-parameters:

Parameter

Type

Required

Description

int64

false

记录唯一ID

tenantId

int64

false

租户ID

remark

string

false

备注

createUserId

int64

false

记录创建者ID

creator

string

false

记录创建者

createTime

string

false

记录创建时间

modifyUserId

int64

false

记录最后更新者ID

updater

string

false

记录最后更新者

modifyTime

string

false

记录最后更新时间

deleteFlag

int32

false

逻辑删除标识

auditDataVersion

int32

false

锁版本

ouId

int64

false

No comments found.

rateType

string

false

No comments found.

rateType2

string

false

No comments found.

rateType3

string

false

No comments found.

rateStatus

string

false

No comments found.

rateStatus2

string

false

No comments found.

rateSource

string

false

No comments found.

fromCurr

string

false

No comments found.

toCurr

string

false

No comments found.

calMethod

string

false

No comments found.

ratio

float

false

No comments found.

ratio2

float

false

No comments found.

ratio3

float

false

No comments found.

validFrom

string

false

No comments found.

validTo

string

false

No comments found.

periodId

int32

false

No comments found.

fromCurrName

string

false

No comments found.

toCurrName

string

false

No comments found.

Request-body:

{
  "id": 949,
  "tenantId": 215,
  "remark": "wwtqrb",
  "createUserId": 97,
  "creator": "6qpmp6",
  "createTime": "2023-02-13 08:31:51",
  "modifyUserId": 547,
  "updater": "xkuiv0",
  "modifyTime": "2023-02-13 08:31:51",
  "deleteFlag": 9,
  "auditDataVersion": 808,
  "ouId": 825,
  "rateType": "7aplqq",
  "rateType2": "f1v1ey",
  "rateType3": "4rvisf",
  "rateStatus": "jdn6n4",
  "rateStatus2": "qypng3",
  "rateSource": "2svpec",
  "fromCurr": "j9vdeu",
  "toCurr": "rsw9ca",
  "calMethod": "et1pyw",
  "ratio": 86.29,
  "ratio2": 2.35,
  "ratio3": 28.86,
  "validFrom": "2023-02-13 08:31:51",
  "validTo": "2023-02-13 08:31:51",
  "periodId": 899,
  "fromCurrName": "marg.collier",
  "toCurrName": "marg.collier"
}

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

└─any object

object

any object.

time

string

响应时间

Response-example:

{
  "code": 346,
  "msg": "iza3qa",
  "errorMsg": "pccwt4",
  "success": true,
  "errorNo": "z02v7x",
  "data": {},
  "time": "2023-02-13 08:31:51"
}

Curl-example:

curl -X PUT -H 'Content-Type: application/json' -H 'Authorization' -i http://127.0.0.1:9010/com/comCurrRate/ --data '{
  "id": 949,
  "tenantId": 215,
  "remark": "wwtqrb",
  "createUserId": 97,
  "creator": "6qpmp6",
  "createTime": "2023-02-13 08:31:51",
  "modifyUserId": 547,
  "updater": "xkuiv0",
  "modifyTime": "2023-02-13 08:31:51",
  "deleteFlag": 9,
  "auditDataVersion": 808,
  "ouId": 825,
  "rateType": "7aplqq",
  "rateType2": "f1v1ey",
  "rateType3": "4rvisf",
  "rateStatus": "jdn6n4",
  "rateStatus2": "qypng3",
  "rateSource": "2svpec",
  "fromCurr": "j9vdeu",
  "toCurr": "rsw9ca",
  "calMethod": "et1pyw",
  "ratio": 86.29,
  "ratio2": 2.35,
  "ratio3": 28.86,
  "validFrom": "2023-02-13 08:31:51",
  "validTo": "2023-02-13 08:31:51",
  "periodId": 899,
  "fromCurrName": "marg.collier",
  "toCurrName": "marg.collier"
}'

2.7.7. 删除汇率

URL: http://127.0.0.1:9010/com/comCurrRate/{id}

Type: DELETE

Author: ssy

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 删除汇率

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Path-parameters:

Parameter

Value

Type

Required

Description

int64

true

汇率ID

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

└─any object

object

any object.

time

string

响应时间

Response-example:

{
  "code": 976,
  "msg": "mqupvg",
  "errorMsg": "61kgob",
  "success": true,
  "errorNo": "ehvtsv",
  "data": {},
  "time": "2023-02-13 08:31:51"
}

Curl-example:

curl -X DELETE -H 'Authorization' -i http://127.0.0.1:9010/com/comCurrRate/719

2.7.8. 批量删除汇率

URL: http://127.0.0.1:9010/com/comCurrRate/deleteBatch/{ids}

Type: DELETE

Author: ssy

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 批量删除汇率

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Path-parameters:

Parameter

Value

Type

Required

Description

ids

array

true

汇率ID,[array of int64]

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

└─any object

object

any object.

time

string

响应时间

Response-example:

{
  "code": 314,
  "msg": "nb28ix",
  "errorMsg": "awkcjp",
  "success": true,
  "errorNo": "vct3h6",
  "data": {},
  "time": "2023-02-13 08:31:51"
}

Curl-example:

curl -X DELETE -H 'Authorization' -i http://127.0.0.1:9010/com/comCurrRate/deleteBatch/657,889

2.7.9. 更新删除标识

URL: http://127.0.0.1:9010/com/comCurrRate/updateDeleteFlag/{id}

Type: PATCH

Author: ssy

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 更新删除标识

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Path-parameters:

Parameter

Value

Type

Required

Description

int64

true

汇率ID

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

└─any object

object

any object.

time

string

响应时间

Response-example:

{
  "code": 299,
  "msg": "gnut00",
  "errorMsg": "0z4k3j",
  "success": true,
  "errorNo": "pem510",
  "data": {},
  "time": "2023-02-13 08:31:51"
}

Curl-example:

curl -X PATCH -H 'Authorization' -i http://127.0.0.1:9010/com/comCurrRate/updateDeleteFlag/740

2.8.

2.8.1.

URL: http://127.0.0.1:9010/sys/component/user/paging

Type: POST

Author: Chris

Content-Type: application/json

Description:

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Body-parameters:

Parameter

Type

Required

Description

current

int32

false

页码

size

int32

false

页大小

keyword

string

false

搜索关键字

orders

array

false

排序

└─column

string

false

属性名称

└─asc

boolean

false

是否升序

username

string

false

No comments found.

firstName

string

false

No comments found.

lastName

string

false

No comments found.

mobile

string

false

No comments found.

string

false

No comments found.

Request-body:

{
  "current": 22,
  "size": 10,
  "keyword": "kxy7yo",
  "orders": [
    {
      "column": "xl9tgx",
      "asc": true
    }
  ],
  "username": "marg.collier",
  "firstName": "marg.collier",
  "lastName": "marg.collier",
  "mobile": "(734) 208-3091",
  "email": "celinda.goldner@gmail.com"
}

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

└─total

int64

总记录数

└─records

array

数据列表

└─id

int64

No comments found.

└─username

string

No comments found.

└─lastName

string

No comments found.

└─firstName

string

No comments found.

└─mobile

string

No comments found.

└─email

string

No comments found.

time

string

响应时间

Response-example:

{
  "code": 871,
  "msg": "4ef5cy",
  "errorMsg": "wqsdd6",
  "success": true,
  "errorNo": "ajys7u",
  "data": {
    "total": 855,
    "records": [
      {
        "id": 931,
        "username": "marg.collier",
        "lastName": "marg.collier",
        "firstName": "marg.collier",
        "mobile": "(734) 208-3091",
        "email": "celinda.goldner@gmail.com"
      }
    ]
  },
  "time": "2023-02-13 08:31:51"
}

Curl-example:

curl -X POST -H 'Content-Type: application/json' -H 'Authorization' -i http://127.0.0.1:9010/sys/component/user/paging --data '{
  "current": 22,
  "size": 10,
  "keyword": "kxy7yo",
  "orders": [
    {
      "column": "xl9tgx",
      "asc": true
    }
  ],
  "username": "marg.collier",
  "firstName": "marg.collier",
  "lastName": "marg.collier",
  "mobile": "(734) 208-3091",
  "email": "celinda.goldner@gmail.com"
}'

3. 系统域

3.1. 接口访问记录.

3.1.1. 分页查询记录

URL: http://127.0.0.1:9010/query

Type: POST

Author: Kaiser（wang shao）

Content-Type: application/json

Description: 分页查询记录

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Body-parameters:

Parameter

Type

Required

Description

current

int32

false

页码

size

int32

false

页大小

keyword

string

false

搜索关键字

orders

array

false

排序

└─column

string

false

属性名称

└─asc

boolean

false

是否升序

requestTimeStart

string

false

请求开始时间起始时间

requestTimeEnd

string

false

请求开始时间截止时间

costMin

int64

false

耗时范围最小耗时

costMax

int64

false

耗时范围最大耗时

route

string

false

路由

username

string

false

用户名

client

string

false

客户端

appCode

string

false

应用编码

resultCode

int32

false

响应结果码

success

boolean

false

是否成功

Request-body:

{
  "current": 28,
  "size": 10,
  "keyword": "vom13t",
  "orders": [
    {
      "column": "4xxzzw",
      "asc": true
    }
  ],
  "requestTimeStart": "2023-02-13 08:31:51",
  "requestTimeEnd": "2023-02-13 08:31:51",
  "costMin": 854,
  "costMax": 706,
  "route": "1qykbt",
  "username": "marg.collier",
  "client": "d919x3",
  "appCode": "99507",
  "resultCode": 312,
  "success": true
}

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

└─total

int64

总记录数

└─records

array

数据列表

└─id

int64

访问起始时间

└─requestTime

string

访问起始时间

└─responseTime

string

访问结束时间

└─cost

int64

访问耗时，毫秒

└─uri

string

访问路径

└─username

string

用户名

└─client

string

访问客户度

└─appCode

string

应用编码

└─resultCode

int32

状态码

└─success

boolean

请求成功

time

string

响应时间

Response-example:

{
  "code": 923,
  "msg": "ksmw23",
  "errorMsg": "5fg1k4",
  "success": true,
  "errorNo": "phqslp",
  "data": {
    "total": 855,
    "records": [
      {
        "id": 828,
        "requestTime": "2023-02-13 08:31:51",
        "responseTime": "2023-02-13 08:31:51",
        "cost": 88,
        "uri": "zl27yf",
        "username": "marg.collier",
        "client": "ugq70x",
        "appCode": "99507",
        "resultCode": 667,
        "success": true
      }
    ]
  },
  "time": "2023-02-13 08:31:51"
}

Curl-example:

curl -X POST -H 'Content-Type: application/json' -H 'Authorization' -i http://127.0.0.1:9010/query --data '{
  "current": 28,
  "size": 10,
  "keyword": "vom13t",
  "orders": [
    {
      "column": "4xxzzw",
      "asc": true
    }
  ],
  "requestTimeStart": "2023-02-13 08:31:51",
  "requestTimeEnd": "2023-02-13 08:31:51",
  "costMin": 854,
  "costMax": 706,
  "route": "1qykbt",
  "username": "marg.collier",
  "client": "d919x3",
  "appCode": "99507",
  "resultCode": 312,
  "success": true
}'

3.1.2. 查看详细记录

URL: http://127.0.0.1:9010/detail/{id}

Type: GET

Author: Kaiser（wang shao）

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 查看详细记录

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Path-parameters:

Parameter

Value

Type

Required

Description

int64

true

记录ID

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

└─id

int64

访问起始时间

└─requestTime

string

访问起始时间

└─responseTime

string

访问结束时间

└─cost

int64

访问耗时，毫秒

└─uri

string

访问路径

└─queryParams

string

查询参数

└─route

string

路由

└─username

string

用户名

└─client

string

访问客户度

└─requestBody

object

请求体

└─any object

object

any object.

└─appCode

string

应用编码

└─resultCode

int32

状态码

└─success

boolean

请求成功

time

string

响应时间

Response-example:

{
  "code": 568,
  "msg": "z93rx6",
  "errorMsg": "m9lib5",
  "success": true,
  "errorNo": "81faw0",
  "data": {
    "id": 781,
    "requestTime": "2023-02-13 08:31:51",
    "responseTime": "2023-02-13 08:31:51",
    "cost": 996,
    "uri": "752j7d",
    "queryParams": "zcnsln",
    "route": "xlgn15",
    "username": "marg.collier",
    "client": "um5hk0",
    "requestBody": {
      "object": "any object"
    },
    "appCode": "99507",
    "resultCode": 349,
    "success": true
  },
  "time": "2023-02-13 08:31:51"
}

Curl-example:

curl -X GET -H 'Authorization' -i http://127.0.0.1:9010/detail/641

3.2. 发号器规则明细管理

3.2.1. 批量创建或更换规则明细

URL: http://127.0.0.1:9010/sys/numbering/ruledtls/

Type: POST

Author: Michael Li

Content-Type: application/json

Description: 批量创建或更换规则明细

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Body-parameters:

Parameter

Type

Required

Description

int64

false

ruleId

int64

false

发号器规则ID

seq

int32

false

排序号

numberType

string

true

取号类型 [UDC]SYS:NUMBERTYPE

numberTypeName

string

false

取号类型名称

numberPattern

string

true

取号模式

nnLen

int32

false

自增序号宽度，默认左补零

Request-body:

[
  {
    "id": 87,
    "ruleId": 716,
    "seq": 984,
    "numberType": "6hvqc4",
    "numberTypeName": "marg.collier",
    "numberPattern": "di1kg4",
    "nnLen": 114
  }
]

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

int64

响应数据

time

string

响应时间

Response-example:

{
  "code": 597,
  "msg": "x7j7uc",
  "errorMsg": "geyaxm",
  "success": true,
  "errorNo": "65c65x",
  "data": 229,
  "time": "2023-02-13 08:31:51"
}

Curl-example:

curl -X POST -H 'Content-Type: application/json' -H 'Authorization' -i http://127.0.0.1:9010/sys/numbering/ruledtls/ --data '[
  {
    "id": 87,
    "ruleId": 716,
    "seq": 984,
    "numberType": "6hvqc4",
    "numberTypeName": "marg.collier",
    "numberPattern": "di1kg4",
    "nnLen": 114
  }
]'

3.2.2. 批量删除规则明细

URL: http://127.0.0.1:9010/sys/numbering/ruledtls/

Type: DELETE

Author: Michael Li

Content-Type: application/json

Description: 批量删除规则明细

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Body-parameters:

Parameter

Type

Required

Description

ids

array

false

规则明细ID,[array of int64]@since

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

└─any object

object

any object.

time

string

响应时间

Response-example:

{
  "code": 997,
  "msg": "ttjpft",
  "errorMsg": "xll46v",
  "success": true,
  "errorNo": "act766",
  "data": {},
  "time": "2023-02-13 08:31:51"
}

Curl-example:

curl -X DELETE -H 'Content-Type: application/json' -H 'Authorization' -i http://127.0.0.1:9010/sys/numbering/ruledtls/ --data '[]'

3.3.

3.3.1.

URL: http://127.0.0.1:9010/sys/butable/search

Type: POST

Content-Type: application/json

Description:

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Body-parameters:

Parameter

Type

Required

Description

current

int32

false

页码

size

int32

false

页大小

keyword

string

false

搜索关键字

orders

array

false

排序

└─column

string

false

属性名称

└─asc

boolean

false

是否升序

butableName

string

false

No comments found.

useNull

int32

false

No comments found.

deleteFlag

int32

false

No comments found.

Request-body:

{
  "current": 41,
  "size": 10,
  "keyword": "s9n06z",
  "orders": [
    {
      "column": "ghictf",
      "asc": true
    }
  ],
  "butableName": "marg.collier",
  "useNull": 969,
  "deleteFlag": 9
}

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

└─total

int64

总记录数

└─records

array

数据列表

└─id

int64

No comments found.

└─butableName

string

No comments found.

└─useNull

int32

No comments found.

time

string

响应时间

Response-example:

{
  "code": 348,
  "msg": "4hyb9p",
  "errorMsg": "xxcf53",
  "success": true,
  "errorNo": "ak89mr",
  "data": {
    "total": 392,
    "records": [
      {
        "id": 910,
        "butableName": "marg.collier",
        "useNull": 163
      }
    ]
  },
  "time": "2023-02-13 08:31:51"
}

Curl-example:

curl -X POST -H 'Content-Type: application/json' -H 'Authorization' -i http://127.0.0.1:9010/sys/butable/search --data '{
  "current": 41,
  "size": 10,
  "keyword": "s9n06z",
  "orders": [
    {
      "column": "ghictf",
      "asc": true
    }
  ],
  "butableName": "marg.collier",
  "useNull": 969,
  "deleteFlag": 9
}'

3.3.2.

URL: http://127.0.0.1:9010/sys/butable/create

Type: POST

Content-Type: application/json

Description:

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Body-parameters:

Parameter

Type

Required

Description

int64

false

No comments found.

butableName

string

false

No comments found.

useNull

int32

false

No comments found.

Request-body:

{
  "id": 186,
  "butableName": "marg.collier",
  "useNull": 465
}

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

int64

响应数据

time

string

响应时间

Response-example:

{
  "code": 217,
  "msg": "g2zxxh",
  "errorMsg": "rsrvas",
  "success": true,
  "errorNo": "y05s8p",
  "data": 44,
  "time": "2023-02-13 08:31:51"
}

Curl-example:

curl -X POST -H 'Content-Type: application/json' -H 'Authorization' -i http://127.0.0.1:9010/sys/butable/create --data '{
  "id": 186,
  "butableName": "marg.collier",
  "useNull": 465
}'

3.3.3.

URL: http://127.0.0.1:9010/sys/butable/update

Type: PUT

Content-Type: application/json

Description:

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Body-parameters:

Parameter

Type

Required

Description

int64

false

No comments found.

butableName

string

false

No comments found.

useNull

int32

false

No comments found.

Request-body:

{
  "id": 955,
  "butableName": "marg.collier",
  "useNull": 800
}

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

└─any object

object

any object.

time

string

响应时间

Response-example:

{
  "code": 458,
  "msg": "92gncj",
  "errorMsg": "76ykxr",
  "success": true,
  "errorNo": "sacmfz",
  "data": {},
  "time": "2023-02-13 08:31:51"
}

Curl-example:

curl -X PUT -H 'Content-Type: application/json' -H 'Authorization' -i http://127.0.0.1:9010/sys/butable/update --data '{
  "id": 955,
  "butableName": "marg.collier",
  "useNull": 800
}'

3.3.4.

URL: http://127.0.0.1:9010/sys/butable/logicDelete/{id}

Type: GET

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description:

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Path-parameters:

Parameter

Value

Type

Required

Description

int64

true

No comments found.

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

└─any object

object

any object.

time

string

响应时间

Response-example:

{
  "code": 570,
  "msg": "myquoe",
  "errorMsg": "w2dqvf",
  "success": true,
  "errorNo": "ixs55j",
  "data": {},
  "time": "2023-02-13 08:31:51"
}

Curl-example:

curl -X GET -H 'Authorization' -i http://127.0.0.1:9010/sys/butable/logicDelete/446

3.3.5.

URL: http://127.0.0.1:9010/sys/butable/getById/{id}

Type: GET

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description:

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Path-parameters:

Parameter

Value

Type

Required

Description

int64

true

No comments found.

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

└─id

int64

No comments found.

└─butableName

string

No comments found.

└─useNull

int32

No comments found.

time

string

响应时间

Response-example:

{
  "code": 123,
  "msg": "nevd2k",
  "errorMsg": "uxf5ix",
  "success": true,
  "errorNo": "p22nef",
  "data": {
    "id": 559,
    "butableName": "marg.collier",
    "useNull": 657
  },
  "time": "2023-02-13 08:31:51"
}

Curl-example:

curl -X GET -H 'Authorization' -i http://127.0.0.1:9010/sys/butable/getById/495

3.4. 功能说明

3.4.1.

URL: http://127.0.0.1:9010/sys/watermarkConfig/findOne

Type: GET

Author: roman.zhang

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description:

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

└─id

int64

记录唯一ID

└─dynamicField

array

动态文字

└─customField

string

自定义文字

└─fontSize

int32

文字大小

└─fontColor

string

颜色深浅

└─rotate

int32

旋转角度

└─stackingDeep

int32

层叠深度

└─tenantId

int64

租户ID

└─remark

string

备注

└─createUserId

int64

记录创建者ID

└─creator

string

记录创建者

└─createTime

string

记录创建时间

└─modifyUserId

int64

记录最后更新者ID

└─updater

string

记录最后更新者

└─modifyTime

string

记录最后更新时间

└─deleteFlag

int32

逻辑删除，0：未删除，1：已删除

└─auditDataVersion

int32

锁版本

└─secBuId

int64

sec_bu_id

└─secUserId

int64

sec_user_id

└─secOuId

int64

sec_ou_id

time

string

响应时间

Response-example:

{
  "code": 457,
  "msg": "urw6zo",
  "errorMsg": "3ch32x",
  "success": true,
  "errorNo": "hzybit",
  "data": {
    "id": 484,
    "dynamicField": [
      "6k66h4"
    ],
    "customField": "a10vyf",
    "fontSize": 10,
    "fontColor": "laake3",
    "rotate": 347,
    "stackingDeep": 41,
    "tenantId": 711,
    "remark": "yto8j0",
    "createUserId": 884,
    "creator": "w8ccki",
    "createTime": "2023-02-13 08:31:50",
    "modifyUserId": 906,
    "updater": "qqywzh",
    "modifyTime": "2023-02-13 08:31:50",
    "deleteFlag": 9,
    "auditDataVersion": 796,
    "secBuId": 622,
    "secUserId": 213,
    "secOuId": 317
  },
  "time": "2023-02-13 08:31:51"
}

Curl-example:

curl -X GET -H 'Authorization' -i http://127.0.0.1:9010/sys/watermarkConfig/findOne

3.4.2. 通过主键查询单条数据

URL: http://127.0.0.1:9010/sys/watermarkConfig/findIdOne/{id}

Type: GET

Author: roman.zhang

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 通过主键查询单条数据

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Path-parameters:

Parameter

Value

Type

Required

Description

int64

true

主键

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

└─id

int64

记录唯一ID

└─dynamicField

array

动态文字

└─customField

string

自定义文字

└─fontSize

int32

文字大小

└─fontColor

string

颜色深浅

└─rotate

int32

旋转角度

└─stackingDeep

int32

层叠深度

└─tenantId

int64

租户ID

└─remark

string

备注

└─createUserId

int64

记录创建者ID

└─creator

string

记录创建者

└─createTime

string

记录创建时间

└─modifyUserId

int64

记录最后更新者ID

└─updater

string

记录最后更新者

└─modifyTime

string

记录最后更新时间

└─deleteFlag

int32

逻辑删除，0：未删除，1：已删除

└─auditDataVersion

int32

锁版本

└─secBuId

int64

sec_bu_id

└─secUserId

int64

sec_user_id

└─secOuId

int64

sec_ou_id

time

string

响应时间

Response-example:

{
  "code": 301,
  "msg": "zk9dkm",
  "errorMsg": "usj7qn",
  "success": true,
  "errorNo": "azx8jz",
  "data": {
    "id": 35,
    "dynamicField": [
      "bsuo0k"
    ],
    "customField": "5s7wzj",
    "fontSize": 10,
    "fontColor": "9nsxsr",
    "rotate": 17,
    "stackingDeep": 366,
    "tenantId": 9,
    "remark": "u1vnjj",
    "createUserId": 129,
    "creator": "qvlary",
    "createTime": "2023-02-13 08:31:50",
    "modifyUserId": 329,
    "updater": "tgivxx",
    "modifyTime": "2023-02-13 08:31:50",
    "deleteFlag": 9,
    "auditDataVersion": 304,
    "secBuId": 294,
    "secUserId": 528,
    "secOuId": 51
  },
  "time": "2023-02-13 08:31:51"
}

Curl-example:

curl -X GET -H 'Authorization' -i http://127.0.0.1:9010/sys/watermarkConfig/findIdOne/84

3.4.3. 根据关键字段查询数据

URL: http://127.0.0.1:9010/sys/watermarkConfig/findCodeOne/{key}

Type: GET

Author: roman.zhang

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据关键字段查询数据

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Path-parameters:

Parameter

Value

Type

Required

Description

key

string

true

参数

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

└─id

int64

记录唯一ID

└─dynamicField

array

动态文字

└─customField

string

自定义文字

└─fontSize

int32

文字大小

└─fontColor

string

颜色深浅

└─rotate

int32

旋转角度

└─stackingDeep

int32

层叠深度

└─tenantId

int64

租户ID

└─remark

string

备注

└─createUserId

int64

记录创建者ID

└─creator

string

记录创建者

└─createTime

string

记录创建时间

└─modifyUserId

int64

记录最后更新者ID

└─updater

string

记录最后更新者

└─modifyTime

string

记录最后更新时间

└─deleteFlag

int32

逻辑删除，0：未删除，1：已删除

└─auditDataVersion

int32

锁版本

└─secBuId

int64

sec_bu_id

└─secUserId

int64

sec_user_id

└─secOuId

int64

sec_ou_id

time

string

响应时间

Response-example:

{
  "code": 283,
  "msg": "qggb2p",
  "errorMsg": "k2up2t",
  "success": true,
  "errorNo": "g0jc4y",
  "data": {
    "id": 709,
    "dynamicField": [
      "un0jbt"
    ],
    "customField": "cqd8ux",
    "fontSize": 10,
    "fontColor": "mc0mb5",
    "rotate": 122,
    "stackingDeep": 882,
    "tenantId": 215,
    "remark": "c56lbq",
    "createUserId": 335,
    "creator": "srvw0j",
    "createTime": "2023-02-13 08:31:50",
    "modifyUserId": 732,
    "updater": "rdybgv",
    "modifyTime": "2023-02-13 08:31:50",
    "deleteFlag": 9,
    "auditDataVersion": 303,
    "secBuId": 483,
    "secUserId": 205,
    "secOuId": 315
  },
  "time": "2023-02-13 08:31:51"
}

Curl-example:

curl -X GET -H 'Authorization' -i http://127.0.0.1:9010/sys/watermarkConfig/findCodeOne/2ikj5l

3.4.4. 分页查询

URL: http://127.0.0.1:9010/sys/watermarkConfig/search

Type: POST

Author: roman.zhang

Content-Type: application/json

Description: 分页查询

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Body-parameters:

Parameter

Type

Required

Description

current

int32

false

页码

size

int32

false

页大小

keyword

string

false

搜索关键字

orders

array

false

排序

└─column

string

false

属性名称

└─asc

boolean

false

是否升序

int64

false

记录唯一ID

dynamicField

array

false

动态文字

customField

string

false

自定义文字

fontSize

int32

false

文字大小

fontColor

string

false

颜色深浅

rotate

int32

false

旋转角度

stackingDeep

int32

false

层叠深度

tenantId

int64

false

租户ID

remark

string

false

备注

createUserId

int64

false

记录创建者ID

creator

string

false

记录创建者

createTime

string

false

记录创建时间

modifyUserId

int64

false

记录最后更新者ID

updater

string

false

记录最后更新者

modifyTime

string

false

记录最后更新时间

deleteFlag

int32

false

逻辑删除，0：未删除，1：已删除

auditDataVersion

int32

false

锁版本

secBuId

int64

false

sec_bu_id

secUserId

int64

false

sec_user_id

secOuId

int64

false

sec_ou_id

Request-body:

{
  "current": 484,
  "size": 10,
  "keyword": "2ywkk2",
  "orders": [
    {
      "column": "8bx6p7",
      "asc": true
    }
  ],
  "id": 730,
  "dynamicField": [
    "ikx96l"
  ],
  "customField": "8atk3g",
  "fontSize": 10,
  "fontColor": "e5v4rv",
  "rotate": 717,
  "stackingDeep": 418,
  "tenantId": 809,
  "remark": "xgx5hs",
  "createUserId": 598,
  "creator": "z5f2da",
  "createTime": "2023-02-13 08:31:50",
  "modifyUserId": 318,
  "updater": "nq3irq",
  "modifyTime": "2023-02-13 08:31:50",
  "deleteFlag": 9,
  "auditDataVersion": 217,
  "secBuId": 436,
  "secUserId": 746,
  "secOuId": 708
}

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

└─total

int64

总记录数

└─records

array

数据列表

└─id

int64

记录唯一ID

└─dynamicField

array

动态文字

└─customField

string

自定义文字

└─fontSize

int32

文字大小

└─fontColor

string

颜色深浅

└─rotate

int32

旋转角度

└─stackingDeep

int32

层叠深度

└─tenantId

int64

租户ID

└─remark

string

备注

└─createUserId

int64

记录创建者ID

└─creator

string

记录创建者

└─createTime

string

记录创建时间

└─modifyUserId

int64

记录最后更新者ID

└─updater

string

记录最后更新者

└─modifyTime

string

记录最后更新时间

└─deleteFlag

int32

逻辑删除，0：未删除，1：已删除

└─auditDataVersion

int32

锁版本

└─secBuId

int64

sec_bu_id

└─secUserId

int64

sec_user_id

└─secOuId

int64

sec_ou_id

time

string

响应时间

Response-example:

{
  "code": 639,
  "msg": "6oxag4",
  "errorMsg": "cdxpwb",
  "success": true,
  "errorNo": "275opg",
  "data": {
    "total": 444,
    "records": [
      {
        "id": 676,
        "dynamicField": [
          "xsp93s"
        ],
        "customField": "txxva1",
        "fontSize": 10,
        "fontColor": "d1nd73",
        "rotate": 991,
        "stackingDeep": 89,
        "tenantId": 326,
        "remark": "40ung0",
        "createUserId": 509,
        "creator": "2m2dq7",
        "createTime": "2023-02-13 08:31:50",
        "modifyUserId": 252,
        "updater": "0kijrs",
        "modifyTime": "2023-02-13 08:31:50",
        "deleteFlag": 9,
        "auditDataVersion": 264,
        "secBuId": 284,
        "secUserId": 890,
        "secOuId": 410
      }
    ]
  },
  "time": "2023-02-13 08:31:51"
}

Curl-example:

curl -X POST -H 'Content-Type: application/json' -H 'Authorization' -i http://127.0.0.1:9010/sys/watermarkConfig/search --data '{
  "current": 484,
  "size": 10,
  "keyword": "2ywkk2",
  "orders": [
    {
      "column": "8bx6p7",
      "asc": true
    }
  ],
  "id": 730,
  "dynamicField": [
    "ikx96l"
  ],
  "customField": "8atk3g",
  "fontSize": 10,
  "fontColor": "e5v4rv",
  "rotate": 717,
  "stackingDeep": 418,
  "tenantId": 809,
  "remark": "xgx5hs",
  "createUserId": 598,
  "creator": "z5f2da",
  "createTime": "2023-02-13 08:31:50",
  "modifyUserId": 318,
  "updater": "nq3irq",
  "modifyTime": "2023-02-13 08:31:50",
  "deleteFlag": 9,
  "auditDataVersion": 217,
  "secBuId": 436,
  "secUserId": 746,
  "secOuId": 708
}'

3.4.5. 新增数据

URL: http://127.0.0.1:9010/sys/watermarkConfig/createOne

Type: POST

Author: roman.zhang

Content-Type: application/json

Description: 新增数据

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Body-parameters:

Parameter

Type

Required

Description

int64

false

记录唯一ID

dynamicField

array

true

动态文字

customField

string

false

自定义文字

fontSize

int32

false

文字大小

fontColor

string

false

颜色深浅

rotate

int32

false

旋转角度

stackingDeep

int32

false

层叠深度

tenantId

int64

false

租户ID

remark

string

false

备注

createUserId

int64

false

记录创建者ID

creator

string

false

记录创建者

createTime

string

false

记录创建时间

modifyUserId

int64

false

记录最后更新者ID

updater

string

false

记录最后更新者

modifyTime

string

false

记录最后更新时间

deleteFlag

int32

false

逻辑删除，0：未删除，1：已删除

auditDataVersion

int32

false

锁版本

secBuId

int64

false

sec_bu_id

secUserId

int64

false

sec_user_id

secOuId

int64

false

sec_ou_id

Request-body:

{
  "id": 464,
  "dynamicField": [
    "cmi6rs"
  ],
  "customField": "haduw8",
  "fontSize": 10,
  "fontColor": "dpu134",
  "rotate": 760,
  "stackingDeep": 298,
  "tenantId": 15,
  "remark": "l4ny8r",
  "createUserId": 831,
  "creator": "ej4hvx",
  "createTime": "2023-02-13 08:31:50",
  "modifyUserId": 820,
  "updater": "2updkf",
  "modifyTime": "2023-02-13 08:31:50",
  "deleteFlag": 9,
  "auditDataVersion": 176,
  "secBuId": 651,
  "secUserId": 466,
  "secOuId": 432
}

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

└─any object

object

any object.

time

string

响应时间

Response-example:

{
  "code": 635,
  "msg": "oo6jcy",
  "errorMsg": "s20fpb",
  "success": true,
  "errorNo": "30da69",
  "data": {},
  "time": "2023-02-13 08:31:51"
}

Curl-example:

curl -X POST -H 'Content-Type: application/json' -H 'Authorization' -i http://127.0.0.1:9010/sys/watermarkConfig/createOne --data '{
  "id": 464,
  "dynamicField": [
    "cmi6rs"
  ],
  "customField": "haduw8",
  "fontSize": 10,
  "fontColor": "dpu134",
  "rotate": 760,
  "stackingDeep": 298,
  "tenantId": 15,
  "remark": "l4ny8r",
  "createUserId": 831,
  "creator": "ej4hvx",
  "createTime": "2023-02-13 08:31:50",
  "modifyUserId": 820,
  "updater": "2updkf",
  "modifyTime": "2023-02-13 08:31:50",
  "deleteFlag": 9,
  "auditDataVersion": 176,
  "secBuId": 651,
  "secUserId": 466,
  "secOuId": 432
}'

3.4.6. 批量新增数据

URL: http://127.0.0.1:9010/sys/watermarkConfig/createBatch

Type: POST

Author: roman.zhang

Content-Type: application/json

Description: 批量新增数据

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Body-parameters:

Parameter

Type

Required

Description

int64

false

记录唯一ID

dynamicField

array

true

动态文字

customField

string

false

自定义文字

fontSize

int32

false

文字大小

fontColor

string

false

颜色深浅

rotate

int32

false

旋转角度

stackingDeep

int32

false

层叠深度

tenantId

int64

false

租户ID

remark

string

false

备注

createUserId

int64

false

记录创建者ID

creator

string

false

记录创建者

createTime

string

false

记录创建时间

modifyUserId

int64

false

记录最后更新者ID

updater

string

false

记录最后更新者

modifyTime

string

false

记录最后更新时间

deleteFlag

int32

false

逻辑删除，0：未删除，1：已删除

auditDataVersion

int32

false

锁版本

secBuId

int64

false

sec_bu_id

secUserId

int64

false

sec_user_id

secOuId

int64

false

sec_ou_id

Request-body:

[
  {
    "id": 146,
    "dynamicField": [
      "iurisd"
    ],
    "customField": "lcw7j8",
    "fontSize": 10,
    "fontColor": "t4461l",
    "rotate": 640,
    "stackingDeep": 673,
    "tenantId": 651,
    "remark": "4shy5y",
    "createUserId": 207,
    "creator": "5t4ec7",
    "createTime": "2023-02-13 08:31:50",
    "modifyUserId": 889,
    "updater": "7amzdj",
    "modifyTime": "2023-02-13 08:31:50",
    "deleteFlag": 9,
    "auditDataVersion": 675,
    "secBuId": 228,
    "secUserId": 889,
    "secOuId": 463
  }
]

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

└─any object

object

any object.

time

string

响应时间

Response-example:

{
  "code": 361,
  "msg": "iq3sq1",
  "errorMsg": "z0fyor",
  "success": true,
  "errorNo": "ysvtvq",
  "data": {},
  "time": "2023-02-13 08:31:51"
}

Curl-example:

curl -X POST -H 'Content-Type: application/json' -H 'Authorization' -i http://127.0.0.1:9010/sys/watermarkConfig/createBatch --data '[
  {
    "id": 146,
    "dynamicField": [
      "iurisd"
    ],
    "customField": "lcw7j8",
    "fontSize": 10,
    "fontColor": "t4461l",
    "rotate": 640,
    "stackingDeep": 673,
    "tenantId": 651,
    "remark": "4shy5y",
    "createUserId": 207,
    "creator": "5t4ec7",
    "createTime": "2023-02-13 08:31:50",
    "modifyUserId": 889,
    "updater": "7amzdj",
    "modifyTime": "2023-02-13 08:31:50",
    "deleteFlag": 9,
    "auditDataVersion": 675,
    "secBuId": 228,
    "secUserId": 889,
    "secOuId": 463
  }
]'

3.4.7. 修改数据

URL: http://127.0.0.1:9010/sys/watermarkConfig/update

Type: PUT

Author: roman.zhang

Content-Type: application/json

Description: 修改数据

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Body-parameters:

Parameter

Type

Required

Description

int64

false

记录唯一ID

dynamicField

array

false

动态文字

customField

string

false

自定义文字

fontSize

int32

false

文字大小

fontColor

string

false

颜色深浅

rotate

int32

false

旋转角度

stackingDeep

int32

false

层叠深度

tenantId

int64

false

租户ID

remark

string

false

备注

createUserId

int64

false

记录创建者ID

creator

string

false

记录创建者

createTime

string

false

记录创建时间

modifyUserId

int64

false

记录最后更新者ID

updater

string

false

记录最后更新者

modifyTime

string

false

记录最后更新时间

deleteFlag

int32

false

逻辑删除，0：未删除，1：已删除

auditDataVersion

int32

false

锁版本

secBuId

int64

false

sec_bu_id

secUserId

int64

false

sec_user_id

secOuId

int64

false

sec_ou_id

Request-body:

{
  "id": 555,
  "dynamicField": [
    "ivhoc3"
  ],
  "customField": "jtmy3b",
  "fontSize": 10,
  "fontColor": "iq75sd",
  "rotate": 612,
  "stackingDeep": 220,
  "tenantId": 309,
  "remark": "jrzk1d",
  "createUserId": 151,
  "creator": "z3rsvt",
  "createTime": "2023-02-13 08:31:50",
  "modifyUserId": 443,
  "updater": "urwapz",
  "modifyTime": "2023-02-13 08:31:50",
  "deleteFlag": 9,
  "auditDataVersion": 637,
  "secBuId": 583,
  "secUserId": 467,
  "secOuId": 642
}

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

└─any object

object

any object.

time

string

响应时间

Response-example:

{
  "code": 939,
  "msg": "uqnv5z",
  "errorMsg": "6zjnl9",
  "success": true,
  "errorNo": "65m0wz",
  "data": {},
  "time": "2023-02-13 08:31:51"
}

Curl-example:

curl -X PUT -H 'Content-Type: application/json' -H 'Authorization' -i http://127.0.0.1:9010/sys/watermarkConfig/update --data '{
  "id": 555,
  "dynamicField": [
    "ivhoc3"
  ],
  "customField": "jtmy3b",
  "fontSize": 10,
  "fontColor": "iq75sd",
  "rotate": 612,
  "stackingDeep": 220,
  "tenantId": 309,
  "remark": "jrzk1d",
  "createUserId": 151,
  "creator": "z3rsvt",
  "createTime": "2023-02-13 08:31:50",
  "modifyUserId": 443,
  "updater": "urwapz",
  "modifyTime": "2023-02-13 08:31:50",
  "deleteFlag": 9,
  "auditDataVersion": 637,
  "secBuId": 583,
  "secUserId": 467,
  "secOuId": 642
}'

3.4.8. 根据主键删除数据

URL: http://127.0.0.1:9010/sys/watermarkConfig/deleteOne/{id}

Type: DELETE

Author: roman.zhang

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据主键删除数据

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Path-parameters:

Parameter

Value

Type

Required

Description

int64

true

主键

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

└─any object

object

any object.

time

string

响应时间

Response-example:

{
  "code": 498,
  "msg": "zfpxdj",
  "errorMsg": "zjy7mw",
  "success": true,
  "errorNo": "ug7fwm",
  "data": {},
  "time": "2023-02-13 08:31:51"
}

Curl-example:

curl -X DELETE -H 'Authorization' -i http://127.0.0.1:9010/sys/watermarkConfig/deleteOne/987

3.4.9. 批量删除

URL: http://127.0.0.1:9010/sys/watermarkConfig/deleteBatch

Type: DELETE

Author: roman.zhang

Content-Type: application/json

Description: 批量删除

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Body-parameters:

Parameter

Type

Required

Description

ids

array

false

删除数据集合,[array of int64]@since

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

└─any object

object

any object.

time

string

响应时间

Response-example:

{
  "code": 10,
  "msg": "ueqru5",
  "errorMsg": "scxscg",
  "success": true,
  "errorNo": "1xgg4j",
  "data": {},
  "time": "2023-02-13 08:31:51"
}

Curl-example:

curl -X DELETE -H 'Content-Type: application/json' -H 'Authorization' -i http://127.0.0.1:9010/sys/watermarkConfig/deleteBatch --data '[]'

3.4.10. 逻辑删除

URL: http://127.0.0.1:9010/sys/watermarkConfig/updateDeleteFlag/{id}

Type: PUT

Author: roman.zhang

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 逻辑删除

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Path-parameters:

Parameter

Value

Type

Required

Description

int64

true

更新数据

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

└─any object

object

any object.

time

string

响应时间

Response-example:

{
  "code": 136,
  "msg": "d517v6",
  "errorMsg": "sfqpuv",
  "success": true,
  "errorNo": "f7d6ug",
  "data": {},
  "time": "2023-02-13 08:31:51"
}

Curl-example:

curl -X PUT -H 'Authorization' -i http://127.0.0.1:9010/sys/watermarkConfig/updateDeleteFlag/781

3.5.

3.5.1.

URL: http://127.0.0.1:9010/sys/data/roles/{roleCode}/constraints

Type: GET

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description:

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Path-parameters:

Parameter

Value

Type

Required

Description

roleCode

string

true

No comments found.

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

time

string

响应时间

Response-example:

{
  "code": 906,
  "msg": "01ymt6",
  "errorMsg": "o2jc04",
  "success": true,
  "errorNo": "93y9s7",
  "data": {},
  "time": "2023-02-13 08:31:51"
}

Curl-example:

curl -X GET -H 'Authorization' -i http://127.0.0.1:9010/sys/data/roles/99507/constraints

3.5.2.

URL: http://127.0.0.1:9010/sys/data/roles/{roleCode}/constraints

Type: POST

Content-Type: application/json

Description:

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Path-parameters:

Parameter

Value

Type

Required

Description

roleCode

string

true

No comments found.

Body-parameters:

Parameter

Type

Required

Description

metaColumnId

int64

false

No comments found.

compareOpCode

string

false

No comments found.

compareOpName

string

false

No comments found.

constraintValues

string

false

No comments found.

Request-body:

[
  {
    "metaColumnId": 481,
    "compareOpCode": "99507",
    "compareOpName": "marg.collier",
    "constraintValues": "k95e6h"
  }
]

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

time

string

响应时间

Response-example:

{
  "code": 379,
  "msg": "thw90l",
  "errorMsg": "h90xw4",
  "success": true,
  "errorNo": "f3xy7m",
  "data": {},
  "time": "2023-02-13 08:31:51"
}

Curl-example:

curl -X POST -H 'Content-Type: application/json' -H 'Authorization' -i http://127.0.0.1:9010/sys/data/roles/99507/constraints --data '[
  {
    "metaColumnId": 481,
    "compareOpCode": "99507",
    "compareOpName": "marg.collier",
    "constraintValues": "k95e6h"
  }
]'

3.5.3.

URL: http://127.0.0.1:9010/sys/data/roles/dataAuthBusinessTestDemo

Type: GET

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description:

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

time

string

响应时间

Response-example:

{
  "code": 496,
  "msg": "3y6au4",
  "errorMsg": "q9rbqi",
  "success": true,
  "errorNo": "fgm9vr",
  "data": {},
  "time": "2023-02-13 08:31:51"
}

Curl-example:

curl -X GET -H 'Authorization' -i http://127.0.0.1:9010/sys/data/roles/dataAuthBusinessTestDemo

3.6. 3.7. 发号器规则管理

3.7.1. 创建发号器规则

URL: http://127.0.0.1:9010/sys/numbering/rules

Type: POST

Author: Michael Li

Content-Type: application/json

Description: 创建发号器规则

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Body-parameters:

Parameter

Type

Required

Description

int64

false

ruleCode

string

true

规则编码

ruleName

string

true

规则名称

ruleClass

string

true

规则分类码：[UDC]COM:DOMAIN

ruleClassName

string

false

规则分类码名称

sampleCode

string

false

取号示例

ruleDetails

array

false

规则明细列表

└─id

int64

false

└─ruleId

int64

false

发号器规则ID

└─seq

int32

false

排序号

└─numberType

string

true

取号类型 [UDC]SYS:NUMBERTYPE

└─numberTypeName

string

false

取号类型名称

└─numberPattern

string

true

取号模式

└─nnLen

int32

false

自增序号宽度，默认左补零

Request-body:

{
  "id": 241,
  "ruleCode": "99507",
  "ruleName": "marg.collier",
  "ruleClass": "l9c4c2",
  "ruleClassName": "marg.collier",
  "sampleCode": "99507",
  "ruleDetails": [
    {
      "id": 94,
      "ruleId": 745,
      "seq": 500,
      "numberType": "dkvl30",
      "numberTypeName": "marg.collier",
      "numberPattern": "z4ef9i",
      "nnLen": 480
    }
  ]
}

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

int64

响应数据

time

string

响应时间

Response-example:

{
  "code": 498,
  "msg": "azyefl",
  "errorMsg": "xo4lde",
  "success": true,
  "errorNo": "lkhkyy",
  "data": 205,
  "time": "2023-02-13 08:31:51"
}

Curl-example:

curl -X POST -H 'Content-Type: application/json' -H 'Authorization' -i http://127.0.0.1:9010/sys/numbering/rules --data '{
  "id": 241,
  "ruleCode": "99507",
  "ruleName": "marg.collier",
  "ruleClass": "l9c4c2",
  "ruleClassName": "marg.collier",
  "sampleCode": "99507",
  "ruleDetails": [
    {
      "id": 94,
      "ruleId": 745,
      "seq": 500,
      "numberType": "dkvl30",
      "numberTypeName": "marg.collier",
      "numberPattern": "z4ef9i",
      "nnLen": 480
    }
  ]
}'

3.7.2. 更新发号器规则

URL: http://127.0.0.1:9010/sys/numbering/rules

Type: PUT

Author: Michael Li

Content-Type: application/json

Description: 更新发号器规则

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Body-parameters:

Parameter

Type

Required

Description

int64

false

ruleCode

string

true

规则编码

ruleName

string

true

规则名称

ruleClass

string

true

规则分类码：[UDC]COM:DOMAIN

ruleClassName

string

false

规则分类码名称

sampleCode

string

false

取号示例

ruleDetails

array

false

规则明细列表

└─id

int64

false

└─ruleId

int64

false

发号器规则ID

└─seq

int32

false

排序号

└─numberType

string

true

取号类型 [UDC]SYS:NUMBERTYPE

└─numberTypeName

string

false

取号类型名称

└─numberPattern

string

true

取号模式

└─nnLen

int32

false

自增序号宽度，默认左补零

Request-body:

{
  "id": 812,
  "ruleCode": "99507",
  "ruleName": "marg.collier",
  "ruleClass": "7ukfpe",
  "ruleClassName": "marg.collier",
  "sampleCode": "99507",
  "ruleDetails": [
    {
      "id": 998,
      "ruleId": 608,
      "seq": 252,
      "numberType": "35iejz",
      "numberTypeName": "marg.collier",
      "numberPattern": "hav16s",
      "nnLen": 723
    }
  ]
}

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

int64

响应数据

time

string

响应时间

Response-example:

{
  "code": 656,
  "msg": "2ujpti",
  "errorMsg": "xsl3l2",
  "success": true,
  "errorNo": "yscxs9",
  "data": 628,
  "time": "2023-02-13 08:31:51"
}

Curl-example:

curl -X PUT -H 'Content-Type: application/json' -H 'Authorization' -i http://127.0.0.1:9010/sys/numbering/rules --data '{
  "id": 812,
  "ruleCode": "99507",
  "ruleName": "marg.collier",
  "ruleClass": "7ukfpe",
  "ruleClassName": "marg.collier",
  "sampleCode": "99507",
  "ruleDetails": [
    {
      "id": 998,
      "ruleId": 608,
      "seq": 252,
      "numberType": "35iejz",
      "numberTypeName": "marg.collier",
      "numberPattern": "hav16s",
      "nnLen": 723
    }
  ]
}'

3.7.3. 检索发号器规则

URL: http://127.0.0.1:9010/sys/numbering/q

Type: POST

Author: Michael Li

Content-Type: application/json

Description: 检索发号器规则

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Body-parameters:

Parameter

Type

Required

Description

current

int32

false

页码

size

int32

false

页大小

keyword

string

false

搜索关键字

orders

array

false

排序

└─column

string

false

属性名称

└─asc

boolean

false

是否升序

ruleCode

string

false

No comments found.

ruleName

string

false

No comments found.

ruleClass

string

false

No comments found.

Request-body:

{
  "current": 980,
  "size": 10,
  "keyword": "0hqqz7",
  "orders": [
    {
      "column": "1icflw",
      "asc": true
    }
  ],
  "ruleCode": "99507",
  "ruleName": "marg.collier",
  "ruleClass": "8hicch"
}

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

└─total

int64

总记录数

└─records

array

数据列表

└─id

int64

└─ruleCode

string

规则编码

└─ruleName

string

规则名称

└─ruleClass

string

规则分类码：[UDC]COM:DOMAIN

└─ruleClassName

string

规则分类码名称

└─sampleCode

string

取号示例

└─ruleDetails

array

规则明细列表

└─id

int64

└─ruleId

int64

发号器规则ID

└─seq

int32

排序号

└─numberType

string

取号类型 [UDC]SYS:NUMBERTYPE

└─numberTypeName

string

取号类型名称

└─numberPattern

string

取号模式

└─nnLen

int32

自增序号宽度，默认左补零

time

string

响应时间

Response-example:

{
  "code": 698,
  "msg": "lzlcj4",
  "errorMsg": "4awhn9",
  "success": true,
  "errorNo": "zyl3kp",
  "data": {
    "total": 652,
    "records": [
      {
        "id": 229,
        "ruleCode": "99507",
        "ruleName": "marg.collier",
        "ruleClass": "73oi53",
        "ruleClassName": "marg.collier",
        "sampleCode": "99507",
        "ruleDetails": [
          {
            "id": 563,
            "ruleId": 944,
            "seq": 955,
            "numberType": "ipitbx",
            "numberTypeName": "marg.collier",
            "numberPattern": "mchm5w",
            "nnLen": 110
          }
        ]
      }
    ]
  },
  "time": "2023-02-13 08:31:51"
}

Curl-example:

curl -X POST -H 'Content-Type: application/json' -H 'Authorization' -i http://127.0.0.1:9010/sys/numbering/q --data '{
  "current": 980,
  "size": 10,
  "keyword": "0hqqz7",
  "orders": [
    {
      "column": "1icflw",
      "asc": true
    }
  ],
  "ruleCode": "99507",
  "ruleName": "marg.collier",
  "ruleClass": "8hicch"
}'

3.7.4. 删除发号器规则

URL: http://127.0.0.1:9010/sys/numbering/rules/{id}

Type: DELETE

Author: Michael Li

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 删除发号器规则

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Path-parameters:

Parameter

Value

Type

Required

Description

int64

true

发号器规则ID

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

boolean

响应数据

time

string

响应时间

Response-example:

{
  "code": 236,
  "msg": "zwjr4v",
  "errorMsg": "2asbhr",
  "success": true,
  "errorNo": "as1xty",
  "data": true,
  "time": "2023-02-13 08:31:51"
}

Curl-example:

curl -X DELETE -H 'Authorization' -i http://127.0.0.1:9010/sys/numbering/rules/192

3.7.5. 生成样例号码

URL: http://127.0.0.1:9010/sys/numbering/samplecode

Type: POST

Author: Michael Li

Content-Type: application/json

Description: 生成样例号码

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Body-parameters:

Parameter

Type

Required

Description

ruleId

int64

true

发号规则ID

runtimeValue

array

false

配置选择的值

Request-body:

{
  "ruleId": 797,
  "runtimeValue": [
    "9o525j"
  ]
}

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

string

响应数据

time

string

响应时间

Response-example:

{
  "code": 204,
  "msg": "33x5m2",
  "errorMsg": "cpizgj",
  "success": true,
  "errorNo": "7wqvrr",
  "data": "ywhh1w",
  "time": "2023-02-13 08:31:51"
}

Curl-example:

curl -X POST -H 'Content-Type: application/json' -H 'Authorization' -i http://127.0.0.1:9010/sys/numbering/samplecode --data '{
  "ruleId": 797,
  "runtimeValue": [
    "9o525j"
  ]
}'

3.7.6. 生成号码

URL: http://127.0.0.1:9010/sys/numbering/code

Type: POST

Author: Michael Li

Content-Type: application/json

Description: 生成号码

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Body-parameters:

Parameter

Type

Required

Description

ruleId

int64

true

发号规则ID

runtimeValue

array

false

配置选择的值

Request-body:

{
  "ruleId": 488,
  "runtimeValue": [
    "9tei1j"
  ]
}

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

string

响应数据

time

string

响应时间

Response-example:

{
  "code": 14,
  "msg": "y8v50n",
  "errorMsg": "vkfvah",
  "success": true,
  "errorNo": "hh7h2k",
  "data": "668cu7",
  "time": "2023-02-13 08:31:51"
}

Curl-example:

curl -X POST -H 'Content-Type: application/json' -H 'Authorization' -i http://127.0.0.1:9010/sys/numbering/code --data '{
  "ruleId": 488,
  "runtimeValue": [
    "9tei1j"
  ]
}'

3.7.7. 获取规则详细信息

URL: http://127.0.0.1:9010/sys/numbering/rules/{id}

Type: GET

Author: Michael Li

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 获取规则详细信息

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Path-parameters:

Parameter

Value

Type

Required

Description

int64

true

规则ID

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

└─id

int64

└─ruleCode

string

规则编码

└─ruleName

string

规则名称

└─ruleClass

string

规则分类码：[UDC]COM:DOMAIN

└─ruleClassName

string

规则分类码名称

└─sampleCode

string

取号示例

└─ruleDetails

array

规则明细列表

└─id

int64

└─ruleId

int64

发号器规则ID

└─seq

int32

排序号

└─numberType

string

取号类型 [UDC]SYS:NUMBERTYPE

└─numberTypeName

string

取号类型名称

└─numberPattern

string

取号模式

└─nnLen

int32

自增序号宽度，默认左补零

time

string

响应时间

Response-example:

{
  "code": 110,
  "msg": "jh3zg3",
  "errorMsg": "7c77zh",
  "success": true,
  "errorNo": "2r6k8d",
  "data": {
    "id": 203,
    "ruleCode": "99507",
    "ruleName": "marg.collier",
    "ruleClass": "ot17na",
    "ruleClassName": "marg.collier",
    "sampleCode": "99507",
    "ruleDetails": [
      {
        "id": 358,
        "ruleId": 709,
        "seq": 815,
        "numberType": "fncctm",
        "numberTypeName": "marg.collier",
        "numberPattern": "5rel8h",
        "nnLen": 5
      }
    ]
  },
  "time": "2023-02-13 08:31:51"
}

Curl-example:

curl -X GET -H 'Authorization' -i http://127.0.0.1:9010/sys/numbering/rules/572

3.8.

3.8.1.

URL: http://127.0.0.1:9010/sys/settings/q

Type: POST

Author: mir

Content-Type: application/json

Description:

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Body-parameters:

Parameter

Type

Required

Description

current

int32

false

页码

size

int32

false

页大小

keyword

string

false

搜索关键字

orders

array

false

排序

└─column

string

false

属性名称

└─asc

boolean

false

是否升序

settingNo

string

false

No comments found.

settingName

string

false

No comments found.

settingNoList

array

false

No comments found.

settingType

string

false

No comments found.

settingType2

string

false

No comments found.

string

false

No comments found.

settingStatus

string

false

No comments found.

settingDesc

string

false

No comments found.

settingVal

string

false

No comments found.

defaultValue

string

false

No comments found.

Request-body:

{
  "current": 46,
  "size": 10,
  "keyword": "5cg0wn",
  "orders": [
    {
      "column": "70212n",
      "asc": true
    }
  ],
  "settingNo": "31o3q1",
  "settingName": "marg.collier",
  "settingNoList": [
    "8ank50"
  ],
  "settingType": "80bgby",
  "settingType2": "townur",
  "email": "celinda.goldner@gmail.com",
  "settingStatus": "x88vum",
  "settingDesc": "zb3cfr",
  "settingVal": "1ixj16",
  "defaultValue": "fmwy40"
}

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

time

string

响应时间

Response-example:

{
  "code": 794,
  "msg": "qay0jg",
  "errorMsg": "33tgkr",
  "success": true,
  "errorNo": "2m521z",
  "data": {},
  "time": "2023-02-13 08:31:51"
}

Curl-example:

curl -X POST -H 'Content-Type: application/json' -H 'Authorization' -i http://127.0.0.1:9010/sys/settings/q --data '{
  "current": 46,
  "size": 10,
  "keyword": "5cg0wn",
  "orders": [
    {
      "column": "70212n",
      "asc": true
    }
  ],
  "settingNo": "31o3q1",
  "settingName": "marg.collier",
  "settingNoList": [
    "8ank50"
  ],
  "settingType": "80bgby",
  "settingType2": "townur",
  "email": "celinda.goldner@gmail.com",
  "settingStatus": "x88vum",
  "settingDesc": "zb3cfr",
  "settingVal": "1ixj16",
  "defaultValue": "fmwy40"
}'

3.8.2.

URL: http://127.0.0.1:9010/sys/settings/byid/{id}

Type: GET

Author: mir

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description:

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Path-parameters:

Parameter

Value

Type

Required

Description

int64

true

No comments found.

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

time

string

响应时间

Response-example:

{
  "code": 608,
  "msg": "zxtil1",
  "errorMsg": "kyjxs6",
  "success": true,
  "errorNo": "fhz4re",
  "data": {},
  "time": "2023-02-13 08:31:51"
}

Curl-example:

curl -X GET -H 'Authorization' -i http://127.0.0.1:9010/sys/settings/byid/84

3.8.3.

URL: http://127.0.0.1:9010/sys/settings/byno/{no}

Type: GET

Author: mir

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description:

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Path-parameters:

Parameter

Value

Type

Required

Description

string

true

No comments found.

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

time

string

响应时间

Response-example:

{
  "code": 833,
  "msg": "n6hyti",
  "errorMsg": "913ykk",
  "success": true,
  "errorNo": "ys5oxp",
  "data": {},
  "time": "2023-02-13 08:31:51"
}

Curl-example:

curl -X GET -H 'Authorization' -i http://127.0.0.1:9010/sys/settings/byno/1w8nk0

3.8.4.

URL: http://127.0.0.1:9010/sys/settings/

Type: POST

Author: mir

Content-Type: application/json

Description:

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Body-parameters:

Parameter

Type

Required

Description

int64

false

No comments found.

settingNo

string

true

No comments found.

settingName

string

true

No comments found.

settingType

string

false

No comments found.

settingType2

string

false

No comments found.

string

false

No comments found.

settingStatus

string

false

No comments found.

settingDesc

string

false

No comments found.

settingVal

string

false

No comments found.

defaultValue

string

false

No comments found.

sortNo

int32

false

No comments found.

tenantId

int64

false

No comments found.

remark

string

false

No comments found.

createUserId

int64

false

No comments found.

creator

string

false

No comments found.

createTime

string

false

No comments found.

modifyUserId

int64

false

No comments found.

updater

string

false

No comments found.

modifyTime

string

false

No comments found.

deleteFlag

int32

false

No comments found.

auditDataVersion

int32

false

No comments found.

Request-body:

{
  "id": 139,
  "settingNo": "nbszkr",
  "settingName": "marg.collier",
  "settingType": "lmi1ok",
  "settingType2": "m8jta2",
  "email": "celinda.goldner@gmail.com",
  "settingStatus": "go40oh",
  "settingDesc": "xb8j3c",
  "settingVal": "gt931e",
  "defaultValue": "q23tlj",
  "sortNo": 910,
  "tenantId": 639,
  "remark": "kopt22",
  "createUserId": 640,
  "creator": "kbk4wc",
  "createTime": "2023-02-13 08:31:51",
  "modifyUserId": 715,
  "updater": "k81mv6",
  "modifyTime": "2023-02-13 08:31:51",
  "deleteFlag": 9,
  "auditDataVersion": 294
}

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

time

string

响应时间

Response-example:

{
  "code": 1,
  "msg": "i3zu7y",
  "errorMsg": "y19zex",
  "success": true,
  "errorNo": "20m77v",
  "data": {},
  "time": "2023-02-13 08:31:51"
}

Curl-example:

curl -X POST -H 'Content-Type: application/json' -H 'Authorization' -i http://127.0.0.1:9010/sys/settings/ --data '{
  "id": 139,
  "settingNo": "nbszkr",
  "settingName": "marg.collier",
  "settingType": "lmi1ok",
  "settingType2": "m8jta2",
  "email": "celinda.goldner@gmail.com",
  "settingStatus": "go40oh",
  "settingDesc": "xb8j3c",
  "settingVal": "gt931e",
  "defaultValue": "q23tlj",
  "sortNo": 910,
  "tenantId": 639,
  "remark": "kopt22",
  "createUserId": 640,
  "creator": "kbk4wc",
  "createTime": "2023-02-13 08:31:51",
  "modifyUserId": 715,
  "updater": "k81mv6",
  "modifyTime": "2023-02-13 08:31:51",
  "deleteFlag": 9,
  "auditDataVersion": 294
}'

3.8.5.

URL: http://127.0.0.1:9010/sys/settings/

Type: PUT

Author: mir

Content-Type: application/json

Description:

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Body-parameters:

Parameter

Type

Required

Description

int64

false

No comments found.

settingNo

string

true

No comments found.

settingName

string

true

No comments found.

settingType

string

false

No comments found.

settingType2

string

false

No comments found.

string

false

No comments found.

settingStatus

string

false

No comments found.

settingDesc

string

false

No comments found.

settingVal

string

false

No comments found.

defaultValue

string

false

No comments found.

sortNo

int32

false

No comments found.

tenantId

int64

false

No comments found.

remark

string

false

No comments found.

createUserId

int64

false

No comments found.

creator

string

false

No comments found.

createTime

string

false

No comments found.

modifyUserId

int64

false

No comments found.

updater

string

false

No comments found.

modifyTime

string

false

No comments found.

deleteFlag

int32

false

No comments found.

auditDataVersion

int32

false

No comments found.

Request-body:

{
  "id": 424,
  "settingNo": "6qyscv",
  "settingName": "marg.collier",
  "settingType": "zlb553",
  "settingType2": "6bfzuv",
  "email": "celinda.goldner@gmail.com",
  "settingStatus": "akhoc4",
  "settingDesc": "98krlj",
  "settingVal": "xphv5q",
  "defaultValue": "bjoqva",
  "sortNo": 808,
  "tenantId": 610,
  "remark": "z8lsc0",
  "createUserId": 378,
  "creator": "oi2ygi",
  "createTime": "2023-02-13 08:31:51",
  "modifyUserId": 820,
  "updater": "nyfbat",
  "modifyTime": "2023-02-13 08:31:51",
  "deleteFlag": 9,
  "auditDataVersion": 868
}

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

time

string

响应时间

Response-example:

{
  "code": 835,
  "msg": "zrrwoi",
  "errorMsg": "x5r7ak",
  "success": true,
  "errorNo": "v91swi",
  "data": {},
  "time": "2023-02-13 08:31:51"
}

Curl-example:

curl -X PUT -H 'Content-Type: application/json' -H 'Authorization' -i http://127.0.0.1:9010/sys/settings/ --data '{
  "id": 424,
  "settingNo": "6qyscv",
  "settingName": "marg.collier",
  "settingType": "zlb553",
  "settingType2": "6bfzuv",
  "email": "celinda.goldner@gmail.com",
  "settingStatus": "akhoc4",
  "settingDesc": "98krlj",
  "settingVal": "xphv5q",
  "defaultValue": "bjoqva",
  "sortNo": 808,
  "tenantId": 610,
  "remark": "z8lsc0",
  "createUserId": 378,
  "creator": "oi2ygi",
  "createTime": "2023-02-13 08:31:51",
  "modifyUserId": 820,
  "updater": "nyfbat",
  "modifyTime": "2023-02-13 08:31:51",
  "deleteFlag": 9,
  "auditDataVersion": 868
}'

3.8.6.

URL: http://127.0.0.1:9010/sys/settings/byids

Type: DELETE

Author: mir

Content-Type: application/json

Description:

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Body-parameters:

Parameter

Type

Required

Description

ids

array

false

No comments found.,[array of int64]@since

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

time

string

响应时间

Response-example:

{
  "code": 629,
  "msg": "lqnulw",
  "errorMsg": "ivtuvb",
  "success": true,
  "errorNo": "whleq5",
  "data": {},
  "time": "2023-02-13 08:31:51"
}

Curl-example:

curl -X DELETE -H 'Content-Type: application/json' -H 'Authorization' -i http://127.0.0.1:9010/sys/settings/byids --data '[]'

3.8.7.

URL: http://127.0.0.1:9010/sys/settings/bynos

Type: DELETE

Author: mir

Content-Type: application/json

Description:

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Body-parameters:

Parameter

Type

Required

Description

nos

array

false

No comments found.,[array of string]@since

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

time

string

响应时间

Response-example:

{
  "code": 170,
  "msg": "cce7i1",
  "errorMsg": "k5y8ch",
  "success": true,
  "errorNo": "k9km98",
  "data": {},
  "time": "2023-02-13 08:31:51"
}

Curl-example:

curl -X DELETE -H 'Content-Type: application/json' -H 'Authorization' -i http://127.0.0.1:9010/sys/settings/bynos --data '[]'

3.9.

3.9.1.

URL: http://127.0.0.1:9010/sys/front/config/list/{roleId}/{permissionId}

Type: GET

Author: Chris

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description:

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Path-parameters:

Parameter

Value

Type

Required

Description

roleId

int64

true

No comments found.

permissionId

int64

true

No comments found.

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

array

响应数据

└─id

int64

No comments found.

└─roleId

int64

No comments found.

└─permissionId

int64

No comments found.

└─configCode

string

No comments found.

time

string

响应时间

Response-example:

{
  "code": 178,
  "msg": "muree5",
  "errorMsg": "5r5tmf",
  "success": true,
  "errorNo": "mejby7",
  "data": [
    {
      "id": 861,
      "roleId": 833,
      "permissionId": 34,
      "configCode": "99507"
    }
  ],
  "time": "2023-02-13 08:31:51"
}

Curl-example:

curl -X GET -H 'Authorization' -i http://127.0.0.1:9010/sys/front/config/list/304/444

3.9.2.

URL: http://127.0.0.1:9010/sys/front/config/role/code/{roleId}/{code}

Type: GET

Author: Chris

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description:

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Path-parameters:

Parameter

Value

Type

Required

Description

roleId

int64

true

No comments found.

code

string

true

No comments found.

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

└─id

int64

No comments found.

└─roleId

int64

No comments found.

└─permissionId

int64

No comments found.

└─configCode

string

No comments found.

└─configContext

string

No comments found.

time

string

响应时间

Response-example:

{
  "code": 874,
  "msg": "or8701",
  "errorMsg": "tvj4z0",
  "success": true,
  "errorNo": "dpubng",
  "data": {
    "id": 423,
    "roleId": 269,
    "permissionId": 343,
    "configCode": "99507",
    "configContext": "odv9y2"
  },
  "time": "2023-02-13 08:31:51"
}

Curl-example:

curl -X GET -H 'Authorization' -i http://127.0.0.1:9010/sys/front/config/role/code/70/99507

3.9.3.

URL: http://127.0.0.1:9010/sys/front/config/current/{code}

Type: GET

Author: Chris

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description:

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Path-parameters:

Parameter

Value

Type

Required

Description

code

string

true

No comments found.

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

└─id

int64

No comments found.

└─roleId

int64

No comments found.

└─permissionId

int64

No comments found.

└─configCode

string

No comments found.

└─configContext

string

No comments found.

time

string

响应时间

Response-example:

{
  "code": 441,
  "msg": "h5uli4",
  "errorMsg": "m0ga5h",
  "success": true,
  "errorNo": "bupn4x",
  "data": {
    "id": 739,
    "roleId": 875,
    "permissionId": 493,
    "configCode": "99507",
    "configContext": "smkrzb"
  },
  "time": "2023-02-13 08:31:51"
}

Curl-example:

curl -X GET -H 'Authorization' -i http://127.0.0.1:9010/sys/front/config/current/99507

3.9.4.

URL: http://127.0.0.1:9010/sys/front/config/save

Type: POST

Author: Chris

Content-Type: application/json

Description:

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Body-parameters:

Parameter

Type

Required

Description

int64

false

No comments found.

roleId

int64

true

No comments found.

permissionId

int64

true

No comments found.

configCode

string

true

No comments found.

configContext

string

true

No comments found.

Request-body:

{
  "id": 841,
  "roleId": 644,
  "permissionId": 783,
  "configCode": "99507",
  "configContext": "8vzhg7"
}

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

string

响应数据

time

string

响应时间

Response-example:

{
  "code": 509,
  "msg": "9mflvv",
  "errorMsg": "7l48yu",
  "success": true,
  "errorNo": "cmyar5",
  "data": "jykxng",
  "time": "2023-02-13 08:31:51"
}

Curl-example:

curl -X POST -H 'Content-Type: application/json' -H 'Authorization' -i http://127.0.0.1:9010/sys/front/config/save --data '{
  "id": 841,
  "roleId": 644,
  "permissionId": 783,
  "configCode": "99507",
  "configContext": "8vzhg7"
}'

3.9.5.

URL: http://127.0.0.1:9010/sys/front/config/remove/{id}

Type: DELETE

Author: Chris

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description:

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Path-parameters:

Parameter

Value

Type

Required

Description

int64

true

No comments found.

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

└─any object

object

any object.

time

string

响应时间

Response-example:

{
  "code": 50,
  "msg": "omgg8f",
  "errorMsg": "q02ft5",
  "success": true,
  "errorNo": "cjr6cx",
  "data": {},
  "time": "2023-02-13 08:31:51"
}

Curl-example:

curl -X DELETE -H 'Authorization' -i http://127.0.0.1:9010/sys/front/config/remove/989

3.10. .

3.10.1.

URL: http://127.0.0.1:9010/sys/mng/login/query

Type: POST

Author: Kaiser（wang shao）

Content-Type: application/json

Description:

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Body-parameters:

Parameter

Type

Required

Description

current

int32

false

页码

size

int32

false

页大小

keyword

string

false

搜索关键字

orders

array

false

排序

└─column

string

false

属性名称

└─asc

boolean

false

是否升序

username

string

false

No comments found.

mobile

string

false

No comments found.

string

false

No comments found.

terminal

enum

false

null
BACKEND
APP
APPLET

timeStart

string

false

No comments found.

timeEnd

string

false

No comments found.

Request-body:

{
  "current": 212,
  "size": 10,
  "keyword": "crdq5n",
  "orders": [
    {
      "column": "ocr75f",
      "asc": true
    }
  ],
  "username": "marg.collier",
  "mobile": "(734) 208-3091",
  "email": "celinda.goldner@gmail.com",
  "terminal": "BACKEND",
  "timeStart": "2023-02-13 08:31:51",
  "timeEnd": "2023-02-13 08:31:51"
}

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

└─total

int64

总记录数

└─records

array

数据列表

└─userId

int64

No comments found.

└─username

string

No comments found.

└─mobile

string

No comments found.

└─email

string

No comments found.

└─lastName

string

No comments found.

└─firstName

string

No comments found.

└─terminal

string

No comments found.

└─terminalName

string

No comments found.

└─loginTime

string

No comments found.

└─loginIp

string

No comments found.

time

string

响应时间

Response-example:

{
  "code": 216,
  "msg": "gvvnmi",
  "errorMsg": "6qzo1j",
  "success": true,
  "errorNo": "jgpdip",
  "data": {
    "total": 162,
    "records": [
      {
        "userId": 20,
        "username": "marg.collier",
        "mobile": "(734) 208-3091",
        "email": "celinda.goldner@gmail.com",
        "lastName": "marg.collier",
        "firstName": "marg.collier",
        "terminal": "sohotq",
        "terminalName": "marg.collier",
        "loginTime": "2023-02-13 08:31:51",
        "loginIp": "204.6.73.122"
      }
    ]
  },
  "time": "2023-02-13 08:31:51"
}

Curl-example:

curl -X POST -H 'Content-Type: application/json' -H 'Authorization' -i http://127.0.0.1:9010/sys/mng/login/query --data '{
  "current": 212,
  "size": 10,
  "keyword": "crdq5n",
  "orders": [
    {
      "column": "ocr75f",
      "asc": true
    }
  ],
  "username": "marg.collier",
  "mobile": "(734) 208-3091",
  "email": "celinda.goldner@gmail.com",
  "terminal": "BACKEND",
  "timeStart": "2023-02-13 08:31:51",
  "timeEnd": "2023-02-13 08:31:51"
}'

3.10.2.

URL: http://127.0.0.1:9010/sys/mng/user/count

Type: POST

Author: Kaiser（wang shao）

Content-Type: application/json

Description:

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Body-parameters:

Parameter

Type

Required

Description

base

string

false

No comments found.

timeStart

string

false

No comments found.

timeEnd

string

false

No comments found.

Request-body:

{
  "base": "4z0r8q",
  "timeStart": "2023-02-13 08:31:51",
  "timeEnd": "2023-02-13 08:31:51"
}

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

int64

响应数据

time

string

响应时间

Response-example:

{
  "code": 163,
  "msg": "uixanx",
  "errorMsg": "jzs1mw",
  "success": true,
  "errorNo": "b9e4wo",
  "data": 165,
  "time": "2023-02-13 08:31:51"
}

Curl-example:

curl -X POST -H 'Content-Type: application/json' -H 'Authorization' -i http://127.0.0.1:9010/sys/mng/user/count --data '{
  "base": "4z0r8q",
  "timeStart": "2023-02-13 08:31:51",
  "timeEnd": "2023-02-13 08:31:51"
}'

3.11. <pre>[功能说明]</pre>

3.11.1.

URL: http://127.0.0.1:9010/sys/permissions/newmenu

Type: POST

Author: Michael Li

Content-Type: application/json

Description:

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Body-parameters:

Parameter

Type

Required

Description

code

string

true

权限代码

name

string

true

权限名称

parentId

int64

false

父权限ID

pattern

string

true

URL路径

httpMethod

string

false

URL的HTTP方法

sortNo

int32

false

排列顺序

isHidden

boolean

false

菜单是否隐藏

isQuick

boolean

false

菜单是否隐藏

icon

string

false

菜单图标

terminalCode

string

false

No comments found.

Request-body:

{
  "code": "99507",
  "name": "marg.collier",
  "parentId": 877,
  "pattern": "t280xv",
  "httpMethod": "glfv0j",
  "sortNo": 164,
  "isHidden": true,
  "isQuick": true,
  "icon": "j1t29o",
  "terminalCode": "99507"
}

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

└─any object

object

any object.

time

string

响应时间

Response-example:

{
  "code": 132,
  "msg": "6abmlk",
  "errorMsg": "deadp8",
  "success": true,
  "errorNo": "ifk34g",
  "data": {},
  "time": "2023-02-13 08:31:51"
}

Curl-example:

curl -X POST -H 'Content-Type: application/json' -H 'Authorization' -i http://127.0.0.1:9010/sys/permissions/newmenu --data '{
  "code": "99507",
  "name": "marg.collier",
  "parentId": 877,
  "pattern": "t280xv",
  "httpMethod": "glfv0j",
  "sortNo": 164,
  "isHidden": true,
  "isQuick": true,
  "icon": "j1t29o",
  "terminalCode": "99507"
}'

3.11.2.

URL: http://127.0.0.1:9010/sys/permissions/newaction

Type: POST

Author: Michael Li

Content-Type: application/json

Description:

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Body-parameters:

Parameter

Type

Required

Description

code

string

true

权限代码

name

string

true

权限名称

parentId

int64

false

父权限ID

pattern

string

true

URL路径

httpMethod

string

false

URL的HTTP方法

sortNo

int32

false

排列顺序

isHidden

boolean

false

菜单是否隐藏

isQuick

boolean

false

菜单是否隐藏

icon

string

false

菜单图标

terminalCode

string

false

No comments found.

Request-body:

{
  "code": "99507",
  "name": "marg.collier",
  "parentId": 254,
  "pattern": "reijlk",
  "httpMethod": "p9dm73",
  "sortNo": 805,
  "isHidden": true,
  "isQuick": true,
  "icon": "4cukuk",
  "terminalCode": "99507"
}

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

└─any object

object

any object.

time

string

响应时间

Response-example:

{
  "code": 789,
  "msg": "f7t1wt",
  "errorMsg": "ht8oud",
  "success": true,
  "errorNo": "mxd0r5",
  "data": {},
  "time": "2023-02-13 08:31:51"
}

Curl-example:

curl -X POST -H 'Content-Type: application/json' -H 'Authorization' -i http://127.0.0.1:9010/sys/permissions/newaction --data '{
  "code": "99507",
  "name": "marg.collier",
  "parentId": 254,
  "pattern": "reijlk",
  "httpMethod": "p9dm73",
  "sortNo": 805,
  "isHidden": true,
  "isQuick": true,
  "icon": "4cukuk",
  "terminalCode": "99507"
}'

3.11.3.

URL: http://127.0.0.1:9010/sys/permissions/{id}

Type: GET

Author: Michael Li

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description:

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Path-parameters:

Parameter

Value

Type

Required

Description

int64

true

No comments found.

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

└─id

int64

权限ID

└─code

string

权限代码

└─name

string

权限名称

└─permType

int32

权限类型: 1.菜单；0.按钮或API调用

└─parentId

int64

父权限ID

└─parentName

string

父权限名称"

└─path

string

权限层级路径

└─permLevel

int32

权限层级

└─sortNo

int32

排列顺序

└─pattern

string

URL路径

└─httpMethod

string

URL的HTTP方法

└─isHidden

boolean

菜单是否隐藏

└─icon

string

菜单图标

└─terminalCode

string

No comments found.

└─menuDepth

int32

菜单深度

└─isQuick

boolean

菜单是否隐藏

time

string

响应时间

Response-example:

{
  "code": 370,
  "msg": "ip007z",
  "errorMsg": "qtrcwn",
  "success": true,
  "errorNo": "mclm5z",
  "data": {
    "id": 354,
    "code": "99507",
    "name": "marg.collier",
    "permType": 642,
    "parentId": 388,
    "parentName": "marg.collier",
    "path": "kf6pbv",
    "permLevel": 407,
    "sortNo": 590,
    "pattern": "h32arj",
    "httpMethod": "0dtymt",
    "isHidden": true,
    "icon": "mjhiy5",
    "terminalCode": "99507",
    "menuDepth": 477,
    "isQuick": true
  },
  "time": "2023-02-13 08:31:51"
}

Curl-example:

curl -X GET -H 'Authorization' -i http://127.0.0.1:9010/sys/permissions/722

3.11.4. 获取菜单下的权限按钮

URL: http://127.0.0.1:9010/sys/permissions/actionsbymenu/{id}

Type: GET

Author: Michael Li

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 获取菜单下的权限按钮

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Path-parameters:

Parameter

Value

Type

Required

Description

int64

true

菜单ID

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

array

响应数据

└─id

int64

权限ID

└─code

string

权限代码

└─name

string

权限名称

└─permType

int32

权限类型: 1.菜单；0.按钮或API调用

└─parentId

int64

父权限ID

└─parentName

string

父权限名称"

└─path

string

权限层级路径

└─permLevel

int32

权限层级

└─sortNo

int32

排列顺序

└─pattern

string

URL路径

└─httpMethod

string

URL的HTTP方法

└─isHidden

boolean

菜单是否隐藏

└─icon

string

菜单图标

└─terminalCode

string

No comments found.

└─menuDepth

int32

菜单深度

└─isQuick

boolean

菜单是否隐藏

time

string

响应时间

Response-example:

{
  "code": 446,
  "msg": "m45zv8",
  "errorMsg": "z9l40g",
  "success": true,
  "errorNo": "wducvp",
  "data": [
    {
      "id": 746,
      "code": "99507",
      "name": "marg.collier",
      "permType": 812,
      "parentId": 836,
      "parentName": "marg.collier",
      "path": "uq4r1q",
      "permLevel": 772,
      "sortNo": 286,
      "pattern": "5ak3h4",
      "httpMethod": "gu4wys",
      "isHidden": true,
      "icon": "oesyjg",
      "terminalCode": "99507",
      "menuDepth": 6,
      "isQuick": true
    }
  ],
  "time": "2023-02-13 08:31:51"
}

Curl-example:

curl -X GET -H 'Authorization' -i http://127.0.0.1:9010/sys/permissions/actionsbymenu/873

3.11.5.

URL: http://127.0.0.1:9010/sys/permissions/

Type: PUT

Author: Michael Li

Content-Type: application/json

Description:

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Body-parameters:

Parameter

Type

Required

Description

int64

false

权限ID

parentId

int64

false

父级菜单ID

code

string

false

权限代码

name

string

false

权限名称

pattern

string

false

权限路径模板

httpMethod

string

false

权限路径HTTP方法

sortNo

int32

false

排列顺序

isHidden

boolean

false

菜单是否隐藏

isQuick

boolean

false

菜单是否隐藏

icon

string

false

菜单图标

terminalCode

string

false

No comments found.

Request-body:

{
  "id": 534,
  "parentId": 437,
  "code": "99507",
  "name": "marg.collier",
  "pattern": "jzqjwc",
  "httpMethod": "282jz7",
  "sortNo": 910,
  "isHidden": true,
  "isQuick": true,
  "icon": "mm2zd2",
  "terminalCode": "99507"
}

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

int32

响应数据

time

string

响应时间

Response-example:

{
  "code": 138,
  "msg": "2zyye9",
  "errorMsg": "tvvkg0",
  "success": true,
  "errorNo": "qx7odu",
  "data": 340,
  "time": "2023-02-13 08:31:51"
}

Curl-example:

curl -X PUT -H 'Content-Type: application/json' -H 'Authorization' -i http://127.0.0.1:9010/sys/permissions/ --data '{
  "id": 534,
  "parentId": 437,
  "code": "99507",
  "name": "marg.collier",
  "pattern": "jzqjwc",
  "httpMethod": "282jz7",
  "sortNo": 910,
  "isHidden": true,
  "isQuick": true,
  "icon": "mm2zd2",
  "terminalCode": "99507"
}'

3.11.6.

URL: http://127.0.0.1:9010/sys/permissions/menutree/{terminalCode}

Type: GET

Author: Michael Li

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description:

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Path-parameters:

Parameter

Value

Type

Required

Description

terminalCode

string

true

No comments found.

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

array

响应数据

└─key

int64

└─code

string

编号

└─title

string

名称/标题

└─level

int32

深度等级

└─parentKey

int64

父级Key，指父级ID

└─sortNo

int32

排序号

└─icon

string

图标

└─terminalCode

string

No comments found.

└─isQuick

boolean

菜单是否隐藏

└─children

array

子节点

time

string

响应时间

Response-example:

{
  "code": 816,
  "msg": "1ecsfb",
  "errorMsg": "v194dw",
  "success": true,
  "errorNo": "d8ord0",
  "data": [
    {
      "key": 302,
      "code": "99507",
      "title": "wiv2hi",
      "level": 598,
      "parentKey": 171,
      "sortNo": 440,
      "icon": "k2sm2y",
      "terminalCode": "99507",
      "isQuick": true,
      "children": [
        {
          "$ref": ".."
        }
      ]
    }
  ],
  "time": "2023-02-13 08:31:51"
}

Curl-example:

curl -X GET -H 'Authorization' -i http://127.0.0.1:9010/sys/permissions/menutree/99507

3.11.7.

URL: http://127.0.0.1:9010/sys/permissions/menuactiontree/{terminalCode}

Type: GET

Author: Michael Li

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description:

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Path-parameters:

Parameter

Value

Type

Required

Description

terminalCode

string

true

No comments found.

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

└─any object

object

any object.

time

string

响应时间

Response-example:

{
  "code": 398,
  "msg": "oaoykd",
  "errorMsg": "ao8hvi",
  "success": true,
  "errorNo": "c5p8k7",
  "data": {},
  "time": "2023-02-13 08:31:51"
}

Curl-example:

curl -X GET -H 'Authorization' -i http://127.0.0.1:9010/sys/permissions/menuactiontree/99507

3.11.8.

URL: http://127.0.0.1:9010/sys/permissions/menuacttree/{permId}/{terminalCode}

Type: GET

Author: Michael Li

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description:

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Path-parameters:

Parameter

Value

Type

Required

Description

permId

int64

true

No comments found.

terminalCode

string

true

No comments found.

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

└─any object

object

any object.

time

string

响应时间

Response-example:

{
  "code": 538,
  "msg": "2szbse",
  "errorMsg": "tc83ru",
  "success": true,
  "errorNo": "kad2jc",
  "data": {},
  "time": "2023-02-13 08:31:51"
}

Curl-example:

curl -X GET -H 'Authorization' -i http://127.0.0.1:9010/sys/permissions/menuacttree/166/99507

3.11.9.

URL: http://127.0.0.1:9010/sys/permissions/refreshallwithroles

Type: GET

Author: Michael Li

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description:

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

└─any object

object

any object.

time

string

响应时间

Response-example:

{
  "code": 232,
  "msg": "b55xuk",
  "errorMsg": "11e862",
  "success": true,
  "errorNo": "jlzbiz",
  "data": {},
  "time": "2023-02-13 08:31:51"
}

Curl-example:

curl -X GET -H 'Authorization' -i http://127.0.0.1:9010/sys/permissions/refreshallwithroles

3.11.10.

URL: http://127.0.0.1:9010/sys/permissions/menu/remove/{id}

Type: DELETE

Author: Michael Li

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description:

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Path-parameters:

Parameter

Value

Type

Required

Description

int64

true

No comments found.

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

└─any object

object

any object.

time

string

响应时间

Response-example:

{
  "code": 443,
  "msg": "lz8af8",
  "errorMsg": "opqr58",
  "success": true,
  "errorNo": "t2hp14",
  "data": {},
  "time": "2023-02-13 08:31:51"
}

Curl-example:

curl -X DELETE -H 'Authorization' -i http://127.0.0.1:9010/sys/permissions/menu/remove/895

3.11.11.

URL: http://127.0.0.1:9010/sys/permissions/action/remove/batch

Type: DELETE

Author: Michael Li

Content-Type: application/json

Description:

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Body-parameters:

Parameter

Type

Required

Description

ids

array

false

No comments found.,[array of int64]@since

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

└─any object

object

any object.

time

string

响应时间

Response-example:

{
  "code": 813,
  "msg": "w1k0gs",
  "errorMsg": "659exu",
  "success": true,
  "errorNo": "gzgcfk",
  "data": {},
  "time": "2023-02-13 08:31:51"
}

Curl-example:

curl -X DELETE -H 'Content-Type: application/json' -H 'Authorization' -i http://127.0.0.1:9010/sys/permissions/action/remove/batch --data '[]'

3.12. 系统工具类

3.12.1. 加密字符串

URL: http://127.0.0.1:9010/mng/sys/support/encrypt

Type: GET

Author: Michael Li

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 加密字符串

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Query-parameters:

Parameter

Value

Type

Required

Description

plainText

string

true

明文

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

string

响应数据

time

string

响应时间

Response-example:

{
  "code": 518,
  "msg": "qrdr9k",
  "errorMsg": "1dcey3",
  "success": true,
  "errorNo": "rvdute",
  "data": "yc4jgq",
  "time": "2023-02-13 08:31:51"
}

Curl-example:

curl -X GET -H 'Authorization' -i http://127.0.0.1:9010/mng/sys/support/encrypt?plainText=hr6wgj

3.12.2. 解密字符串

URL: http://127.0.0.1:9010/mng/sys/support/decrypt

Type: GET

Author: Michael Li

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 解密字符串

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Query-parameters:

Parameter

Value

Type

Required

Description

ciphertext

string

true

密文

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

string

响应数据

time

string

响应时间

Response-example:

{
  "code": 174,
  "msg": "2d4iod",
  "errorMsg": "j0d6i1",
  "success": true,
  "errorNo": "7bs2hu",
  "data": "03ste0",
  "time": "2023-02-13 08:31:51"
}

Curl-example:

curl -X GET -H 'Authorization' -i http://127.0.0.1:9010/mng/sys/support/decrypt?ciphertext=he5jx7

3.13. 下一编号管理

3.13.1. 检索下一编号

URL: http://127.0.0.1:9010/sys/numbering/nn/q

Type: POST

Author: Michael Li

Content-Type: application/json

Description: 检索下一编号

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Body-parameters:

Parameter

Type

Required

Description

current

int32

false

页码

size

int32

false

页大小

keyword

string

false

搜索关键字

orders

array

false

排序

└─column

string

false

属性名称

└─asc

boolean

false

是否升序

code

string

false

No comments found.

name

string

false

No comments found.

numberClass

string

false

No comments found.

Request-body:

{
  "current": 451,
  "size": 10,
  "keyword": "5yk3no",
  "orders": [
    {
      "column": "ic2q44",
      "asc": true
    }
  ],
  "code": "99507",
  "name": "marg.collier",
  "numberClass": "f2dw13"
}

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

└─total

int64

总记录数

└─records

array

数据列表

└─id

int64

唯一编号ID

└─code

string

下一编号代码

└─name

string

下一编号名称

└─numberClass

string

下一编号分类

└─step

int32

下一编号步长

└─nextNumber

int64

下一编号取值

└─nnPeriod

string

下一编号周期[UDC]SYS:NNPERIOD

└─nnPeriodName

string

下一编号周期名称

└─nnTime

string

发号时间

time

string

响应时间

Response-example:

{
  "code": 53,
  "msg": "pas87h",
  "errorMsg": "qiw69l",
  "success": true,
  "errorNo": "2njyp2",
  "data": {
    "total": 903,
    "records": [
      {
        "id": 767,
        "code": "99507",
        "name": "marg.collier",
        "numberClass": "ekyc5k",
        "step": 644,
        "nextNumber": 866,
        "nnPeriod": "fqccpg",
        "nnPeriodName": "marg.collier",
        "nnTime": "2023-02-13 08:31:51"
      }
    ]
  },
  "time": "2023-02-13 08:31:51"
}

Curl-example:

curl -X POST -H 'Content-Type: application/json' -H 'Authorization' -i http://127.0.0.1:9010/sys/numbering/nn/q --data '{
  "current": 451,
  "size": 10,
  "keyword": "5yk3no",
  "orders": [
    {
      "column": "ic2q44",
      "asc": true
    }
  ],
  "code": "99507",
  "name": "marg.collier",
  "numberClass": "f2dw13"
}'

3.13.2. 创建新的下一编号

URL: http://127.0.0.1:9010/sys/numbering/nn/

Type: POST

Author: Michael Li

Content-Type: application/json

Description: 创建新的下一编号

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Body-parameters:

Parameter

Type

Required

Description

int64

false

唯一编号ID

code

string

true

下一编号代码

name

string

true

下一编号名称

numberClass

string

false

下一编号分类

step

int32

false

下一编号步长

nextNumber

int64

false

下一编号取值

nnPeriod

string

false

下一编号周期[UDC]SYS:NNPERIOD

nnPeriodName

string

false

下一编号周期名称

nnTime

string

false

发号时间

Request-body:

{
  "id": 421,
  "code": "99507",
  "name": "marg.collier",
  "numberClass": "83y8sv",
  "step": 899,
  "nextNumber": 19,
  "nnPeriod": "r1zap6",
  "nnPeriodName": "marg.collier",
  "nnTime": "2023-02-13 08:31:51"
}

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

int64

响应数据

time

string

响应时间

Response-example:

{
  "code": 554,
  "msg": "8pyjmj",
  "errorMsg": "i4a63o",
  "success": true,
  "errorNo": "kb7pq9",
  "data": 902,
  "time": "2023-02-13 08:31:51"
}

Curl-example:

curl -X POST -H 'Content-Type: application/json' -H 'Authorization' -i http://127.0.0.1:9010/sys/numbering/nn/ --data '{
  "id": 421,
  "code": "99507",
  "name": "marg.collier",
  "numberClass": "83y8sv",
  "step": 899,
  "nextNumber": 19,
  "nnPeriod": "r1zap6",
  "nnPeriodName": "marg.collier",
  "nnTime": "2023-02-13 08:31:51"
}'

3.13.3. 更新下一编号配置

URL: http://127.0.0.1:9010/sys/numbering/nn/

Type: PUT

Author: Michael Li

Content-Type: application/json

Description: 更新下一编号配置

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Body-parameters:

Parameter

Type

Required

Description

int64

false

唯一编号ID

code

string

true

下一编号代码

name

string

true

下一编号名称

numberClass

string

false

下一编号分类

step

int32

false

下一编号步长

nextNumber

int64

false

下一编号取值

nnPeriod

string

false

下一编号周期[UDC]SYS:NNPERIOD

nnPeriodName

string

false

下一编号周期名称

nnTime

string

false

发号时间

Request-body:

{
  "id": 141,
  "code": "99507",
  "name": "marg.collier",
  "numberClass": "w6n6ma",
  "step": 22,
  "nextNumber": 240,
  "nnPeriod": "r66hef",
  "nnPeriodName": "marg.collier",
  "nnTime": "2023-02-13 08:31:51"
}

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

int64

响应数据

time

string

响应时间

Response-example:

{
  "code": 647,
  "msg": "enb7ua",
  "errorMsg": "48r9vu",
  "success": true,
  "errorNo": "kf1ole",
  "data": 344,
  "time": "2023-02-13 08:31:51"
}

Curl-example:

curl -X PUT -H 'Content-Type: application/json' -H 'Authorization' -i http://127.0.0.1:9010/sys/numbering/nn/ --data '{
  "id": 141,
  "code": "99507",
  "name": "marg.collier",
  "numberClass": "w6n6ma",
  "step": 22,
  "nextNumber": 240,
  "nnPeriod": "r66hef",
  "nnPeriodName": "marg.collier",
  "nnTime": "2023-02-13 08:31:51"
}'

3.13.4. 根据ID批量删除

URL: http://127.0.0.1:9010/sys/numbering/nn/

Type: DELETE

Author: Michael Li

Content-Type: application/json

Description: 根据ID批量删除

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Body-parameters:

Parameter

Type

Required

Description

ids

array

false

ID列表,[array of int64]@since

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

boolean

响应数据

time

string

响应时间

Response-example:

{
  "code": 476,
  "msg": "bqtmaj",
  "errorMsg": "lmdglw",
  "success": true,
  "errorNo": "kqssxh",
  "data": true,
  "time": "2023-02-13 08:31:51"
}

Curl-example:

curl -X DELETE -H 'Content-Type: application/json' -H 'Authorization' -i http://127.0.0.1:9010/sys/numbering/nn/ --data '[]'

3.13.5. 根据ID获取对应下一编号

URL: http://127.0.0.1:9010/sys/numbering/nn/{id}

Type: GET

Author: Michael Li

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据ID获取对应下一编号

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Path-parameters:

Parameter

Value

Type

Required

Description

int64

true

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

└─id

int64

唯一编号ID

└─code

string

下一编号代码

└─name

string

下一编号名称

└─numberClass

string

下一编号分类

└─step

int32

下一编号步长

└─nextNumber

int64

下一编号取值

└─nnPeriod

string

下一编号周期[UDC]SYS:NNPERIOD

└─nnPeriodName

string

下一编号周期名称

└─nnTime

string

发号时间

time

string

响应时间

Response-example:

{
  "code": 734,
  "msg": "kdt14q",
  "errorMsg": "a7sndi",
  "success": true,
  "errorNo": "4t6ne0",
  "data": {
    "id": 446,
    "code": "99507",
    "name": "marg.collier",
    "numberClass": "hcgqgf",
    "step": 112,
    "nextNumber": 899,
    "nnPeriod": "cr3fbj",
    "nnPeriodName": "marg.collier",
    "nnTime": "2023-02-13 08:31:51"
  },
  "time": "2023-02-13 08:31:51"
}

Curl-example:

curl -X GET -H 'Authorization' -i http://127.0.0.1:9010/sys/numbering/nn/675

3.14. 系统分类码维护

3.14.1. 分页查询分类码

URL: http://127.0.0.1:9010/sys/codes/q

Type: POST

Author: Michael Li

Content-Type: application/json

Description: 分页查询分类码

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Body-parameters:

Parameter

Type

Required

Description

current

int32

false

页码

size

int32

false

页大小

keyword

string

false

搜索关键字

orders

array

false

排序

└─column

string

false

属性名称

└─asc

boolean

false

是否升序

domainCode

string

false

No comments found.

udcCode

string

false

No comments found.

udcVal

string

false

No comments found.

valDesc

string

false

No comments found.

udcName

string

false

20201110 金小康 start

udcDesc

string

false

No comments found.

codes

array

false

20201110 金小康 end

es2

string

false

No comments found.

Request-body:

{
  "current": 109,
  "size": 10,
  "keyword": "u3ff8j",
  "orders": [
    {
      "column": "huaj9n",
      "asc": true
    }
  ],
  "domainCode": "99507",
  "udcCode": "99507",
  "udcVal": "8u9onc",
  "valDesc": "5ycrk7",
  "udcName": "marg.collier",
  "udcDesc": "gs1f3g",
  "codes": [
    "5z0mu5"
  ],
  "es2": "ana4eh"
}

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

└─total

int64

总记录数

└─records

array

数据列表

└─id

int64

记录唯一ID

└─tenantId

int64

租户ID

└─remark

string

备注

└─createUserId

int64

记录创建者ID

└─creator

string

记录创建者

└─createTime

string

记录创建时间

└─modifyUserId

int64

记录最后更新者ID

└─updater

string

记录最后更新者

└─modifyTime

string

记录最后更新时间

└─deleteFlag

int32

逻辑删除标识

└─auditDataVersion

int32

锁版本

└─domainCode

string

No comments found.

└─udcCode

string

No comments found.

└─udcName

string

No comments found.

└─udcVal

string

No comments found.

└─valDesc

string

No comments found.

└─valSortNo

int32

No comments found.

└─hdFlag

boolean

No comments found.

└─dpFlag

boolean

No comments found.

└─es1

string

No comments found.

└─es2

string

No comments found.

└─es3

string

No comments found.

└─es4

string

No comments found.

└─es5

string

No comments found.

time

string

响应时间

Response-example:

{
  "code": 580,
  "msg": "t2ibk2",
  "errorMsg": "5oxm3p",
  "success": true,
  "errorNo": "6wj89k",
  "data": {
    "total": 99,
    "records": [
      {
        "id": 287,
        "tenantId": 534,
        "remark": "qxs9yw",
        "createUserId": 734,
        "creator": "hz03hv",
        "createTime": "2023-02-13 08:31:51",
        "modifyUserId": 986,
        "updater": "yfw73r",
        "modifyTime": "2023-02-13 08:31:51",
        "deleteFlag": 9,
        "auditDataVersion": 564,
        "domainCode": "99507",
        "udcCode": "99507",
        "udcName": "marg.collier",
        "udcVal": "m2tryk",
        "valDesc": "0n1deg",
        "valSortNo": 702,
        "hdFlag": true,
        "dpFlag": true,
        "es1": "5mmxw8",
        "es2": "uogbtr",
        "es3": "olwky5",
        "es4": "eblt64",
        "es5": "ybn91p"
      }
    ]
  },
  "time": "2023-02-13 08:31:51"
}

Curl-example:

curl -X POST -H 'Content-Type: application/json' -H 'Authorization' -i http://127.0.0.1:9010/sys/codes/q --data '{
  "current": 109,
  "size": 10,
  "keyword": "u3ff8j",
  "orders": [
    {
      "column": "huaj9n",
      "asc": true
    }
  ],
  "domainCode": "99507",
  "udcCode": "99507",
  "udcVal": "8u9onc",
  "valDesc": "5ycrk7",
  "udcName": "marg.collier",
  "udcDesc": "gs1f3g",
  "codes": [
    "5z0mu5"
  ],
  "es2": "ana4eh"
}'

3.14.2. 查看分类码详情

URL: http://127.0.0.1:9010/sys/codes/{id}

Type: GET

Author: Michael Li

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 查看分类码详情

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Path-parameters:

Parameter

Value

Type

Required

Description

int64

true

分类码ID

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

└─any object

object

any object.

time

string

响应时间

Response-example:

{
  "code": 197,
  "msg": "728hjr",
  "errorMsg": "fu5n8l",
  "success": true,
  "errorNo": "45jn17",
  "data": {},
  "time": "2023-02-13 08:31:51"
}

Curl-example:

curl -X GET -H 'Authorization' -i http://127.0.0.1:9010/sys/codes/468

3.14.3. 获取下拉分类码通过领域码和分类码，获取下拉选择用的分类码和描述

URL: http://127.0.0.1:9010/sys/codes/combo/{domain}/{udc}

Type: GET

Author: Michael Li

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 获取下拉分类码通过领域码和分类码，获取下拉选择用的分类码和描述

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Path-parameters:

Parameter

Value

Type

Required

Description

domain

string

true

领域码

udc

string

true

分类码

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

└─any object

object

any object.

time

string

响应时间

Response-example:

{
  "code": 164,
  "msg": "uxkpnh",
  "errorMsg": "cvm9t9",
  "success": true,
  "errorNo": "hopkf8",
  "data": {},
  "time": "2023-02-13 08:31:51"
}

Curl-example:

curl -X GET -H 'Authorization' -i http://127.0.0.1:9010/sys/codes/combo/marquardt.org/c2m6th

3.14.4. 创建分类码

URL: http://127.0.0.1:9010/sys/codes/

Type: POST

Author: Michael Li

Content-Type: application/json

Description: 创建分类码

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Body-parameters:

Parameter

Type

Required

Description

int64

false

记录唯一ID

tenantId

int64

false

租户ID

remark

string

false

备注

createUserId

int64

false

记录创建者ID

creator

string

false

记录创建者

createTime

string

false

记录创建时间

modifyUserId

int64

false

记录最后更新者ID

updater

string

false

记录最后更新者

modifyTime

string

false

记录最后更新时间

deleteFlag

int32

false

逻辑删除标识

auditDataVersion

int32

false

锁版本

domainCode

string

false

No comments found.

udcCode

string

false

No comments found.

udcName

string

false

No comments found.

udcVal

string

false

No comments found.

valDesc

string

true

No comments found.

valSortNo

int32

false

No comments found.

hdFlag

boolean

false

No comments found.

dpFlag

boolean

false

No comments found.

es1

string

false

No comments found.

es2

string

false

No comments found.

es3

string

false

No comments found.

es4

string

false

No comments found.

es5

string

false

No comments found.

Request-body:

{
  "id": 61,
  "tenantId": 310,
  "remark": "xvq381",
  "createUserId": 929,
  "creator": "41qa0a",
  "createTime": "2023-02-13 08:31:51",
  "modifyUserId": 18,
  "updater": "nwts0x",
  "modifyTime": "2023-02-13 08:31:51",
  "deleteFlag": 9,
  "auditDataVersion": 174,
  "domainCode": "99507",
  "udcCode": "99507",
  "udcName": "marg.collier",
  "udcVal": "qgodd1",
  "valDesc": "e21ihf",
  "valSortNo": 216,
  "hdFlag": true,
  "dpFlag": true,
  "es1": "nat6hp",
  "es2": "fotjig",
  "es3": "tj6nkd",
  "es4": "5f8xpj",
  "es5": "67yd98"
}

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

int64

响应数据

time

string

响应时间

Response-example:

{
  "code": 262,
  "msg": "i7zecx",
  "errorMsg": "z13tam",
  "success": true,
  "errorNo": "h3jg0p",
  "data": 991,
  "time": "2023-02-13 08:31:51"
}

Curl-example:

curl -X POST -H 'Content-Type: application/json' -H 'Authorization' -i http://127.0.0.1:9010/sys/codes/ --data '{
  "id": 61,
  "tenantId": 310,
  "remark": "xvq381",
  "createUserId": 929,
  "creator": "41qa0a",
  "createTime": "2023-02-13 08:31:51",
  "modifyUserId": 18,
  "updater": "nwts0x",
  "modifyTime": "2023-02-13 08:31:51",
  "deleteFlag": 9,
  "auditDataVersion": 174,
  "domainCode": "99507",
  "udcCode": "99507",
  "udcName": "marg.collier",
  "udcVal": "qgodd1",
  "valDesc": "e21ihf",
  "valSortNo": 216,
  "hdFlag": true,
  "dpFlag": true,
  "es1": "nat6hp",
  "es2": "fotjig",
  "es3": "tj6nkd",
  "es4": "5f8xpj",
  "es5": "67yd98"
}'

3.14.5. 更新分类码

URL: http://127.0.0.1:9010/sys/codes/

Type: PUT

Author: Michael Li

Content-Type: application/json

Description: 更新分类码

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Body-parameters:

Parameter

Type

Required

Description

int64

false

记录唯一ID

tenantId

int64

false

租户ID

remark

string

false

备注

createUserId

int64

false

记录创建者ID

creator

string

false

记录创建者

createTime

string

false

记录创建时间

modifyUserId

int64

false

记录最后更新者ID

updater

string

false

记录最后更新者

modifyTime

string

false

记录最后更新时间

deleteFlag

int32

false

逻辑删除标识

auditDataVersion

int32

false

锁版本

domainCode

string

false

No comments found.

udcCode

string

false

No comments found.

udcName

string

false

No comments found.

udcVal

string

false

No comments found.

valDesc

string

true

No comments found.

valSortNo

int32

false

No comments found.

hdFlag

boolean

false

No comments found.

dpFlag

boolean

false

No comments found.

es1

string

false

No comments found.

es2

string

false

No comments found.

es3

string

false

No comments found.

es4

string

false

No comments found.

es5

string

false

No comments found.

Request-body:

{
  "id": 532,
  "tenantId": 4,
  "remark": "v4ix0z",
  "createUserId": 30,
  "creator": "ohzo8s",
  "createTime": "2023-02-13 08:31:51",
  "modifyUserId": 232,
  "updater": "pdg7si",
  "modifyTime": "2023-02-13 08:31:51",
  "deleteFlag": 9,
  "auditDataVersion": 378,
  "domainCode": "99507",
  "udcCode": "99507",
  "udcName": "marg.collier",
  "udcVal": "puctq6",
  "valDesc": "u0ouae",
  "valSortNo": 753,
  "hdFlag": true,
  "dpFlag": true,
  "es1": "frlgx2",
  "es2": "g3lyok",
  "es3": "mldl2x",
  "es4": "4wy6yj",
  "es5": "2tb2zo"
}

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

int64

响应数据

time

string

响应时间

Response-example:

{
  "code": 652,
  "msg": "s8t4vf",
  "errorMsg": "cx2c7m",
  "success": true,
  "errorNo": "lkdtko",
  "data": 778,
  "time": "2023-02-13 08:31:51"
}

Curl-example:

curl -X PUT -H 'Content-Type: application/json' -H 'Authorization' -i http://127.0.0.1:9010/sys/codes/ --data '{
  "id": 532,
  "tenantId": 4,
  "remark": "v4ix0z",
  "createUserId": 30,
  "creator": "ohzo8s",
  "createTime": "2023-02-13 08:31:51",
  "modifyUserId": 232,
  "updater": "pdg7si",
  "modifyTime": "2023-02-13 08:31:51",
  "deleteFlag": 9,
  "auditDataVersion": 378,
  "domainCode": "99507",
  "udcCode": "99507",
  "udcName": "marg.collier",
  "udcVal": "puctq6",
  "valDesc": "u0ouae",
  "valSortNo": 753,
  "hdFlag": true,
  "dpFlag": true,
  "es1": "frlgx2",
  "es2": "g3lyok",
  "es3": "mldl2x",
  "es4": "4wy6yj",
  "es5": "2tb2zo"
}'

3.14.6. 删除领域码删除领域下所有非硬编码的UDC

URL: http://127.0.0.1:9010/sys/codes/{syscode}

Type: DELETE

Author: Michael Li

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 删除领域码删除领域下所有非硬编码的UDC

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Path-parameters:

Parameter

Value

Type

Required

Description

syscode

string

true

领域码

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

boolean

响应数据

time

string

响应时间

Response-example:

{
  "code": 980,
  "msg": "cpxa0z",
  "errorMsg": "pfdb8m",
  "success": true,
  "errorNo": "s2xtib",
  "data": true,
  "time": "2023-02-13 08:31:51"
}

Curl-example:

curl -X DELETE -H 'Authorization' -i http://127.0.0.1:9010/sys/codes/99507

3.14.7. 删除领域下UDC

URL: http://127.0.0.1:9010/sys/codes/{syscode}/{modcode}

Type: DELETE

Author: Michael Li

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 删除领域下UDC

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Path-parameters:

Parameter

Value

Type

Required

Description

syscode

string

true

领域码

modcode

string

true

udc编码

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

boolean

响应数据

time

string

响应时间

Response-example:

{
  "code": 38,
  "msg": "0lpni2",
  "errorMsg": "7ooc19",
  "success": true,
  "errorNo": "w48x4m",
  "data": true,
  "time": "2023-02-13 08:31:51"
}

Curl-example:

curl -X DELETE -H 'Authorization' -i http://127.0.0.1:9010/sys/codes/99507/99507

3.14.8. 删除领域下具体UDC值

URL: http://127.0.0.1:9010/sys/codes/{syscode}/{modcode}/{key}

Type: DELETE

Author: Michael Li

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 删除领域下具体UDC值

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Path-parameters:

Parameter

Value

Type

Required

Description

syscode

string

true

领域码

modcode

string

true

udc编码

key

string

true

udc值

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

boolean

响应数据

time

string

响应时间

Response-example:

{
  "code": 108,
  "msg": "2cduyk",
  "errorMsg": "icyrbo",
  "success": true,
  "errorNo": "u6qzub",
  "data": true,
  "time": "2023-02-13 08:31:51"
}

Curl-example:

curl -X DELETE -H 'Authorization' -i http://127.0.0.1:9010/sys/codes/99507/99507/2r9d89

3.14.9. 根据ID批量删除

URL: http://127.0.0.1:9010/sys/codes/idinbatch

Type: DELETE

Author: Michael Li

Content-Type: application/json

Description: 根据ID批量删除

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Body-parameters:

Parameter

Type

Required

Description

ids

array

false

ID,[array of int64]@since

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

boolean

响应数据

time

string

响应时间

Response-example:

{
  "code": 148,
  "msg": "zgky0n",
  "errorMsg": "cyvw7t",
  "success": true,
  "errorNo": "f99hc0",
  "data": true,
  "time": "2023-02-13 08:31:51"
}

Curl-example:

curl -X DELETE -H 'Content-Type: application/json' -H 'Authorization' -i http://127.0.0.1:9010/sys/codes/idinbatch --data '[]'

3.14.10. 清空所有UDC缓存

URL: http://127.0.0.1:9010/sys/codes/cache

Type: DELETE

Author: Michael Li

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 清空所有UDC缓存

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Query-parameters:

Parameter

Value

Type

Required

Description

all

boolean

false

是否清空所有租户的

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

boolean

响应数据

time

string

响应时间

Response-example:

{
  "code": 926,
  "msg": "2hth3h",
  "errorMsg": "6yy3i0",
  "success": true,
  "errorNo": "l4a095",
  "data": true,
  "time": "2023-02-13 08:31:51"
}

Curl-example:

curl -X DELETE -H 'Authorization' -i http://127.0.0.1:9010/sys/codes/cache?all=true

3.14.11. 清空指定UDC缓存

URL: http://127.0.0.1:9010/sys/codes/cache_udc

Type: DELETE

Author: Michael Li

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 清空指定UDC缓存

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Query-parameters:

Parameter

Value

Type

Required

Description

domain

string

false

领域编码

udcCode

string

false

udc编码

all

boolean

false

是否清空所有租户的

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

boolean

响应数据

time

string

响应时间

Response-example:

{
  "code": 982,
  "msg": "x5cf8l",
  "errorMsg": "suqf6l",
  "success": true,
  "errorNo": "rug4q6",
  "data": true,
  "time": "2023-02-13 08:31:51"
}

Curl-example:

curl -X DELETE -H 'Authorization' -i http://127.0.0.1:9010/sys/codes/cache_udc?domain=marquardt.org&udcCode=99507&all=true

3.15. 测试熔断限流,流控等

3.15.1.

URL: http://127.0.0.1:9010/sentinel/getFirstSentinel

Type: GET

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description:

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

└─any object

object

any object.

time

string

响应时间

Response-example:

{
  "code": 935,
  "msg": "rwhx4h",
  "errorMsg": "v7eg04",
  "success": true,
  "errorNo": "9ct0l7",
  "data": {},
  "time": "2023-02-13 08:31:51"
}

Curl-example:

curl -X GET -H 'Authorization' -i http://127.0.0.1:9010/sentinel/getFirstSentinel

3.15.2. 按资源名称限流，需要指定限流处理逻辑

URL: http://127.0.0.1:9010/sentinel/byResource

Type: GET

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 按资源名称限流，需要指定限流处理逻辑

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

└─any object

object

any object.

time

string

响应时间

Response-example:

{
  "code": 686,
  "msg": "8la1ij",
  "errorMsg": "z7e3yg",
  "success": true,
  "errorNo": "gdbq9n",
  "data": {},
  "time": "2023-02-13 08:31:51"
}

Curl-example:

curl -X GET -H 'Authorization' -i http://127.0.0.1:9010/sentinel/byResource

3.15.3.

URL: http://127.0.0.1:9010/sentinel/degrade/{id}

Type: GET

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description:

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Path-parameters:

Parameter

Value

Type

Required

Description

int64

true

No comments found.

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

└─any object

object

any object.

time

string

响应时间

Response-example:

{
  "code": 511,
  "msg": "g3578p",
  "errorMsg": "mvp4k1",
  "success": true,
  "errorNo": "h4kjy0",
  "data": {},
  "time": "2023-02-13 08:31:51"
}

Curl-example:

curl -X GET -H 'Authorization' -i http://127.0.0.1:9010/sentinel/degrade/415

3.15.4.

URL: http://127.0.0.1:9010/sentinel/param-flow

Type: GET

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description:

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Query-parameters:

Parameter

Value

Type

Required

Description

projectUuid

string

false

No comments found.

testUuid

string

false

No comments found.

useInt

int32

false

No comments found.

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

└─any object

object

any object.

time

string

响应时间

Response-example:

{
  "code": 198,
  "msg": "fsop87",
  "errorMsg": "kpnipp",
  "success": true,
  "errorNo": "qzbhw2",
  "data": {},
  "time": "2023-02-13 08:31:51"
}

Curl-example:

curl -X GET -H 'Authorization' -i http://127.0.0.1:9010/sentinel/param-flow?projectUuid=15a735fb-c14e-4375-a6c8-185565863e12&testUuid=15a735fb-c14e-4375-a6c8-185565863e12&useInt=64 --data '&15a735fb-c14e-4375-a6c8-185565863e12&15a735fb-c14e-4375-a6c8-185565863e12&64'

3.16. 功能说明 controller:SysPersonalitySettings

3.16.1.

URL: http://127.0.0.1:9010/sysPersonalitySettings/findParam/{terminalCode}/{personality}/{pid}

Type: GET

Author: meng

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description:

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Path-parameters:

Parameter

Value

Type

Required

Description

terminalCode

string

true

No comments found.

personality

string

true

No comments found.

pid

int64

true

No comments found.

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

array

响应数据

└─id

int64

权限ID

└─parentId

int64

No comments found.

└─code

string

权限编号

└─name

string

权限名称

└─sortNo

int32

排序

└─pattern

string

路由

└─isHidden

boolean

菜单是否隐藏

└─isQuick

boolean

菜单是否隐藏

└─icon

string

图标

└─terminalCode

string

No comments found.

└─childNodes

array

当前子节点数据

time

string

响应时间

Response-example:

{
  "code": 660,
  "msg": "pwe0n2",
  "errorMsg": "zdt1pe",
  "success": true,
  "errorNo": "tv135q",
  "data": [
    {
      "id": 852,
      "parentId": 8,
      "code": "99507",
      "name": "marg.collier",
      "sortNo": 766,
      "pattern": "lbqw47",
      "isHidden": true,
      "isQuick": true,
      "icon": "oe0q6u",
      "terminalCode": "99507",
      "childNodes": [
        {
          "$ref": ".."
        }
      ]
    }
  ],
  "time": "2023-02-13 08:31:52"
}

Curl-example:

curl -X GET -H 'Authorization' -i http://127.0.0.1:9010/sysPersonalitySettings/findParam/99507/j1wjb9/627

3.16.2.

URL: http://127.0.0.1:9010/sysPersonalitySettings/findParam/{terminalCode}/{personality}

Type: GET

Author: meng

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description:

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Path-parameters:

Parameter

Value

Type

Required

Description

terminalCode

string

true

No comments found.

personality

string

true

No comments found.

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

array

响应数据

└─id

int64

权限ID

└─parentId

int64

No comments found.

└─code

string

权限编号

└─name

string

权限名称

└─sortNo

int32

排序

└─pattern

string

路由

└─isHidden

boolean

菜单是否隐藏

└─isQuick

boolean

菜单是否隐藏

└─icon

string

图标

└─terminalCode

string

No comments found.

└─childNodes

array

当前子节点数据

time

string

响应时间

Response-example:

{
  "code": 681,
  "msg": "m3q3od",
  "errorMsg": "ugwjij",
  "success": true,
  "errorNo": "yj4u41",
  "data": [
    {
      "id": 505,
      "parentId": 895,
      "code": "99507",
      "name": "marg.collier",
      "sortNo": 52,
      "pattern": "s4mr7o",
      "isHidden": true,
      "isQuick": true,
      "icon": "ceqy0q",
      "terminalCode": "99507",
      "childNodes": [
        {
          "$ref": ".."
        }
      ]
    }
  ],
  "time": "2023-02-13 08:31:52"
}

Curl-example:

curl -X GET -H 'Authorization' -i http://127.0.0.1:9010/sysPersonalitySettings/findParam/99507/45qigp

3.16.3.

URL: http://127.0.0.1:9010/sysPersonalitySettings/findParamquick/{terminalCode}/{personality}

Type: GET

Author: meng

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description:

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Path-parameters:

Parameter

Value

Type

Required

Description

terminalCode

string

true

No comments found.

personality

string

true

No comments found.

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

array

响应数据

└─id

int64

权限ID

└─parentId

int64

No comments found.

└─code

string

权限编号

└─name

string

权限名称

└─sortNo

int32

排序

└─pattern

string

路由

└─isHidden

boolean

菜单是否隐藏

└─isQuick

boolean

菜单是否隐藏

└─icon

string

图标

└─terminalCode

string

No comments found.

└─childNodes

array

当前子节点数据

time

string

响应时间

Response-example:

{
  "code": 306,
  "msg": "fwjdrh",
  "errorMsg": "1bw173",
  "success": true,
  "errorNo": "vfv0f6",
  "data": [
    {
      "id": 7,
      "parentId": 772,
      "code": "99507",
      "name": "marg.collier",
      "sortNo": 117,
      "pattern": "r8bztm",
      "isHidden": true,
      "isQuick": true,
      "icon": "9r5u76",
      "terminalCode": "99507",
      "childNodes": [
        {
          "$ref": ".."
        }
      ]
    }
  ],
  "time": "2023-02-13 08:31:52"
}

Curl-example:

curl -X GET -H 'Authorization' -i http://127.0.0.1:9010/sysPersonalitySettings/findParamquick/99507/f89hxg

3.16.4.

URL: http://127.0.0.1:9010/sysPersonalitySettings/findParampersonality/{terminalCode}/{personality}

Type: GET

Author: meng

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description:

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Path-parameters:

Parameter

Value

Type

Required

Description

terminalCode

string

true

No comments found.

personality

string

true

No comments found.

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

array

响应数据

└─id

int64

权限ID

└─parentId

int64

No comments found.

└─code

string

权限编号

└─name

string

权限名称

└─sortNo

int32

排序

└─pattern

string

路由

└─isHidden

boolean

菜单是否隐藏

└─isQuick

boolean

菜单是否隐藏

└─icon

string

图标

└─terminalCode

string

No comments found.

└─childNodes

array

当前子节点数据

time

string

响应时间

Response-example:

{
  "code": 431,
  "msg": "poau55",
  "errorMsg": "aipjkp",
  "success": true,
  "errorNo": "nbw1h0",
  "data": [
    {
      "id": 584,
      "parentId": 295,
      "code": "99507",
      "name": "marg.collier",
      "sortNo": 190,
      "pattern": "8bcgl3",
      "isHidden": true,
      "isQuick": true,
      "icon": "4emsbh",
      "terminalCode": "99507",
      "childNodes": [
        {
          "$ref": ".."
        }
      ]
    }
  ],
  "time": "2023-02-13 08:31:52"
}

Curl-example:

curl -X GET -H 'Authorization' -i http://127.0.0.1:9010/sysPersonalitySettings/findParampersonality/99507/smnuej

3.16.5.

URL: http://127.0.0.1:9010/sysPersonalitySettings/findParampersonality/{terminalCode}/{personality}/{pid}

Type: GET

Author: meng

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description:

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Path-parameters:

Parameter

Value

Type

Required

Description

terminalCode

string

true

No comments found.

personality

string

true

No comments found.

pid

int64

true

No comments found.

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

array

响应数据

└─id

int64

权限ID

└─parentId

int64

No comments found.

└─code

string

权限编号

└─name

string

权限名称

└─sortNo

int32

排序

└─pattern

string

路由

└─isHidden

boolean

菜单是否隐藏

└─isQuick

boolean

菜单是否隐藏

└─icon

string

图标

└─terminalCode

string

No comments found.

└─childNodes

array

当前子节点数据

time

string

响应时间

Response-example:

{
  "code": 993,
  "msg": "77iz3p",
  "errorMsg": "1pmrbj",
  "success": true,
  "errorNo": "t17nxm",
  "data": [
    {
      "id": 911,
      "parentId": 152,
      "code": "99507",
      "name": "marg.collier",
      "sortNo": 285,
      "pattern": "f00qrj",
      "isHidden": true,
      "isQuick": true,
      "icon": "egi28n",
      "terminalCode": "99507",
      "childNodes": [
        {
          "$ref": ".."
        }
      ]
    }
  ],
  "time": "2023-02-13 08:31:52"
}

Curl-example:

curl -X GET -H 'Authorization' -i http://127.0.0.1:9010/sysPersonalitySettings/findParampersonality/99507/py7bus/374

3.16.6. 6.新增数据

URL: http://127.0.0.1:9010/sysPersonalitySettings/createOne

Type: POST

Author: meng

Content-Type: application/json

Description: 6.新增数据

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Body-parameters:

Parameter

Type

Required

Description

int64

false

记录唯一ID
nullable : false
default : null

pId

int64

false

权限id
nullable : true
default : null

rId

int64

false

用户ID
nullable : true
default : null

permLevel

int32

false

权限层级
nullable : true
default : null

sortNo

int32

false

排列顺序
nullable : true
default : null

tenantId

int64

false

租户ID
nullable : true
default : null

remark

string

false

备注
nullable : true
default : null

createUserId

int64

false

记录创建者ID
nullable : true
default : null

creator

string

false

记录创建者
nullable : true
default : null

createTime

string

false

记录创建时间
nullable : true
default : null

modifyUserId

int64

false

记录最后更新者ID
nullable : true
default : null

updater

string

false

记录最后更新者
nullable : true
default : null

modifyTime

string

false

记录最后更新时间
nullable : true
default : null

deleteFlag

int32

false

逻辑删除，0：未删除，1：已删除
nullable : true
default : 0

auditDataVersion

int32

false

锁版本
nullable : true
default : null

secBuId

int64

false

sec_bu_id
nullable : true
default : null

secUserId

int64

false

sec_user_id
nullable : true
default : null

personality

string

false

No comments found.

secOuId

int64

false

sec_ou_id
nullable : true
default : null

isQuick

boolean

false

No comments found.

Request-body:

{
  "id": 306,
  "pId": 50,
  "rId": 44,
  "permLevel": 300,
  "sortNo": 533,
  "tenantId": 942,
  "remark": "j4gbef",
  "createUserId": 318,
  "creator": "b1j71w",
  "createTime": "2023-02-13 08:31:52",
  "modifyUserId": 192,
  "updater": "tqsfq0",
  "modifyTime": "2023-02-13 08:31:52",
  "deleteFlag": 9,
  "auditDataVersion": 962,
  "secBuId": 460,
  "secUserId": 564,
  "personality": "0ihi1c",
  "secOuId": 915,
  "isQuick": true
}

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

time

string

响应时间

Response-example:

{
  "code": 808,
  "msg": "2ep8sx",
  "errorMsg": "5ehars",
  "success": true,
  "errorNo": "d121no",
  "data": {},
  "time": "2023-02-13 08:31:52"
}

Curl-example:

curl -X POST -H 'Content-Type: application/json' -H 'Authorization' -i http://127.0.0.1:9010/sysPersonalitySettings/createOne --data '{
  "id": 306,
  "pId": 50,
  "rId": 44,
  "permLevel": 300,
  "sortNo": 533,
  "tenantId": 942,
  "remark": "j4gbef",
  "createUserId": 318,
  "creator": "b1j71w",
  "createTime": "2023-02-13 08:31:52",
  "modifyUserId": 192,
  "updater": "tqsfq0",
  "modifyTime": "2023-02-13 08:31:52",
  "deleteFlag": 9,
  "auditDataVersion": 962,
  "secBuId": 460,
  "secUserId": 564,
  "personality": "0ihi1c",
  "secOuId": 915,
  "isQuick": true
}'

3.16.7. 7.新增数据批量

URL: http://127.0.0.1:9010/sysPersonalitySettings/createAll

Type: POST

Author: meng

Content-Type: application/json

Description: 7.新增数据批量

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Body-parameters:

Parameter

Type

Required

Description

int64

false

记录唯一ID
nullable : false
default : null

pId

int64

false

权限id
nullable : true
default : null

rId

int64

false

用户ID
nullable : true
default : null

permLevel

int32

false

权限层级
nullable : true
default : null

sortNo

int32

false

排列顺序
nullable : true
default : null

tenantId

int64

false

租户ID
nullable : true
default : null

remark

string

false

备注
nullable : true
default : null

createUserId

int64

false

记录创建者ID
nullable : true
default : null

creator

string

false

记录创建者
nullable : true
default : null

createTime

string

false

记录创建时间
nullable : true
default : null

modifyUserId

int64

false

记录最后更新者ID
nullable : true
default : null

updater

string

false

记录最后更新者
nullable : true
default : null

modifyTime

string

false

记录最后更新时间
nullable : true
default : null

deleteFlag

int32

false

逻辑删除，0：未删除，1：已删除
nullable : true
default : 0

auditDataVersion

int32

false

锁版本
nullable : true
default : null

secBuId

int64

false

sec_bu_id
nullable : true
default : null

secUserId

int64

false

sec_user_id
nullable : true
default : null

personality

string

false

No comments found.

secOuId

int64

false

sec_ou_id
nullable : true
default : null

isQuick

boolean

false

No comments found.

Request-body:

[
  {
    "id": 919,
    "pId": 280,
    "rId": 579,
    "permLevel": 756,
    "sortNo": 415,
    "tenantId": 686,
    "remark": "lswgcb",
    "createUserId": 64,
    "creator": "w2odab",
    "createTime": "2023-02-13 08:31:52",
    "modifyUserId": 762,
    "updater": "5k9k81",
    "modifyTime": "2023-02-13 08:31:52",
    "deleteFlag": 9,
    "auditDataVersion": 893,
    "secBuId": 235,
    "secUserId": 108,
    "personality": "mk2z33",
    "secOuId": 719,
    "isQuick": true
  }
]

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

time

string

响应时间

Response-example:

{
  "code": 896,
  "msg": "foa6o3",
  "errorMsg": "vj04hw",
  "success": true,
  "errorNo": "azgd4q",
  "data": {},
  "time": "2023-02-13 08:31:52"
}

Curl-example:

curl -X POST -H 'Content-Type: application/json' -H 'Authorization' -i http://127.0.0.1:9010/sysPersonalitySettings/createAll --data '[
  {
    "id": 919,
    "pId": 280,
    "rId": 579,
    "permLevel": 756,
    "sortNo": 415,
    "tenantId": 686,
    "remark": "lswgcb",
    "createUserId": 64,
    "creator": "w2odab",
    "createTime": "2023-02-13 08:31:52",
    "modifyUserId": 762,
    "updater": "5k9k81",
    "modifyTime": "2023-02-13 08:31:52",
    "deleteFlag": 9,
    "auditDataVersion": 893,
    "secBuId": 235,
    "secUserId": 108,
    "personality": "mk2z33",
    "secOuId": 719,
    "isQuick": true
  }
]'

3.16.8. 8.修改数据

URL: http://127.0.0.1:9010/sysPersonalitySettings/updateOne

Type: POST

Author: meng

Content-Type: application/json

Description: 8.修改数据

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Body-parameters:

Parameter

Type

Required

Description

int64

false

记录唯一ID
nullable : false
default : null

pId

int64

false

权限id
nullable : true
default : null

rId

int64

false

用户ID
nullable : true
default : null

permLevel

int32

false

权限层级
nullable : true
default : null

sortNo

int32

false

排列顺序
nullable : true
default : null

tenantId

int64

false

租户ID
nullable : true
default : null

remark

string

false

备注
nullable : true
default : null

createUserId

int64

false

记录创建者ID
nullable : true
default : null

creator

string

false

记录创建者
nullable : true
default : null

createTime

string

false

记录创建时间
nullable : true
default : null

modifyUserId

int64

false

记录最后更新者ID
nullable : true
default : null

updater

string

false

记录最后更新者
nullable : true
default : null

modifyTime

string

false

记录最后更新时间
nullable : true
default : null

deleteFlag

int32

false

逻辑删除，0：未删除，1：已删除
nullable : true
default : 0

auditDataVersion

int32

false

锁版本
nullable : true
default : null

secBuId

int64

false

sec_bu_id
nullable : true
default : null

secUserId

int64

false

sec_user_id
nullable : true
default : null

personality

string

false

No comments found.

secOuId

int64

false

sec_ou_id
nullable : true
default : null

isQuick

boolean

false

No comments found.

Request-body:

{
  "id": 325,
  "pId": 765,
  "rId": 477,
  "permLevel": 49,
  "sortNo": 51,
  "tenantId": 642,
  "remark": "93edw6",
  "createUserId": 685,
  "creator": "c4tgv1",
  "createTime": "2023-02-13 08:31:52",
  "modifyUserId": 550,
  "updater": "ameomw",
  "modifyTime": "2023-02-13 08:31:52",
  "deleteFlag": 9,
  "auditDataVersion": 28,
  "secBuId": 241,
  "secUserId": 677,
  "personality": "he099i",
  "secOuId": 472,
  "isQuick": true
}

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

time

string

响应时间

Response-example:

{
  "code": 29,
  "msg": "70v85z",
  "errorMsg": "pe799s",
  "success": true,
  "errorNo": "vtljbp",
  "data": {},
  "time": "2023-02-13 08:31:52"
}

Curl-example:

curl -X POST -H 'Content-Type: application/json' -H 'Authorization' -i http://127.0.0.1:9010/sysPersonalitySettings/updateOne --data '{
  "id": 325,
  "pId": 765,
  "rId": 477,
  "permLevel": 49,
  "sortNo": 51,
  "tenantId": 642,
  "remark": "93edw6",
  "createUserId": 685,
  "creator": "c4tgv1",
  "createTime": "2023-02-13 08:31:52",
  "modifyUserId": 550,
  "updater": "ameomw",
  "modifyTime": "2023-02-13 08:31:52",
  "deleteFlag": 9,
  "auditDataVersion": 28,
  "secBuId": 241,
  "secUserId": 677,
  "personality": "he099i",
  "secOuId": 472,
  "isQuick": true
}'

3.16.9. 9.修改数据批量

URL: http://127.0.0.1:9010/sysPersonalitySettings/updateAlls/{personality}

Type: POST

Author: meng

Content-Type: application/json

Description: 9.修改数据批量

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Path-parameters:

Parameter

Value

Type

Required

Description

personality

string

true

No comments found.

Body-parameters:

Parameter

Type

Required

Description

int64

false

记录唯一ID
nullable : false
default : null

pId

int64

false

权限id
nullable : true
default : null

rId

int64

false

用户ID
nullable : true
default : null

permLevel

int32

false

权限层级
nullable : true
default : null

sortNo

int32

false

排列顺序
nullable : true
default : null

tenantId

int64

false

租户ID
nullable : true
default : null

remark

string

false

备注
nullable : true
default : null

createUserId

int64

false

记录创建者ID
nullable : true
default : null

creator

string

false

记录创建者
nullable : true
default : null

createTime

string

false

记录创建时间
nullable : true
default : null

modifyUserId

int64

false

记录最后更新者ID
nullable : true
default : null

updater

string

false

记录最后更新者
nullable : true
default : null

modifyTime

string

false

记录最后更新时间
nullable : true
default : null

deleteFlag

int32

false

逻辑删除，0：未删除，1：已删除
nullable : true
default : 0

auditDataVersion

int32

false

锁版本
nullable : true
default : null

secBuId

int64

false

sec_bu_id
nullable : true
default : null

secUserId

int64

false

sec_user_id
nullable : true
default : null

personality

string

false

No comments found.

secOuId

int64

false

sec_ou_id
nullable : true
default : null

isQuick

boolean

false

No comments found.

Request-body:

[
  {
    "id": 317,
    "pId": 388,
    "rId": 160,
    "permLevel": 105,
    "sortNo": 502,
    "tenantId": 32,
    "remark": "ij9br1",
    "createUserId": 748,
    "creator": "c2lpzg",
    "createTime": "2023-02-13 08:31:52",
    "modifyUserId": 291,
    "updater": "49ihmj",
    "modifyTime": "2023-02-13 08:31:52",
    "deleteFlag": 9,
    "auditDataVersion": 225,
    "secBuId": 795,
    "secUserId": 562,
    "personality": "01l4y0",
    "secOuId": 306,
    "isQuick": true
  }
]

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

time

string

响应时间

Response-example:

{
  "code": 97,
  "msg": "vc0qz4",
  "errorMsg": "7lclub",
  "success": true,
  "errorNo": "n5c6vk",
  "data": {},
  "time": "2023-02-13 08:31:52"
}

Curl-example:

curl -X POST -H 'Content-Type: application/json' -H 'Authorization' -i http://127.0.0.1:9010/sysPersonalitySettings/updateAlls/gpbjpw --data '[
  {
    "id": 317,
    "pId": 388,
    "rId": 160,
    "permLevel": 105,
    "sortNo": 502,
    "tenantId": 32,
    "remark": "ij9br1",
    "createUserId": 748,
    "creator": "c2lpzg",
    "createTime": "2023-02-13 08:31:52",
    "modifyUserId": 291,
    "updater": "49ihmj",
    "modifyTime": "2023-02-13 08:31:52",
    "deleteFlag": 9,
    "auditDataVersion": 225,
    "secBuId": 795,
    "secUserId": 562,
    "personality": "01l4y0",
    "secOuId": 306,
    "isQuick": true
  }
]'

3.16.10. 9.修改数据批量

URL: http://127.0.0.1:9010/sysPersonalitySettings/updateAll/{personality}

Type: POST

Author: meng

Content-Type: application/json

Description: 9.修改数据批量

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Path-parameters:

Parameter

Value

Type

Required

Description

personality

string

true

No comments found.

Body-parameters:

Parameter

Type

Required

Description

int64

false

权限ID

parentId

int64

false

No comments found.

code

string

false

权限编号

name

string

false

权限名称

sortNo

int32

false

排序

pattern

string

false

路由

isHidden

boolean

false

菜单是否隐藏

isQuick

boolean

false

菜单是否隐藏

icon

string

false

图标

terminalCode

string

false

No comments found.

childNodes

array

false

当前子节点数据

Request-body:

[
  {
    "id": 81,
    "parentId": 516,
    "code": "99507",
    "name": "marg.collier",
    "sortNo": 2,
    "pattern": "j18xjy",
    "isHidden": true,
    "isQuick": true,
    "icon": "gb9j4u",
    "terminalCode": "99507",
    "childNodes": [
      {
        "$ref": ".."
      }
    ]
  }
]

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

time

string

响应时间

Response-example:

{
  "code": 167,
  "msg": "hsz9mt",
  "errorMsg": "gafccc",
  "success": true,
  "errorNo": "1lu9ky",
  "data": {},
  "time": "2023-02-13 08:31:52"
}

Curl-example:

curl -X POST -H 'Content-Type: application/json' -H 'Authorization' -i http://127.0.0.1:9010/sysPersonalitySettings/updateAll/06tml6 --data '[
  {
    "id": 81,
    "parentId": 516,
    "code": "99507",
    "name": "marg.collier",
    "sortNo": 2,
    "pattern": "j18xjy",
    "isHidden": true,
    "isQuick": true,
    "icon": "gb9j4u",
    "terminalCode": "99507",
    "childNodes": [
      {
        "$ref": ".."
      }
    ]
  }
]'

3.16.11. 10.基础物理删除

URL: http://127.0.0.1:9010/sysPersonalitySettings/deleteOne/{id}

Type: DELETE

Author: meng

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 10.基础物理删除

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Path-parameters:

Parameter

Value

Type

Required

Description

int64

true

No comments found.

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

└─any object

object

any object.

time

string

响应时间

Response-example:

{
  "code": 210,
  "msg": "kf2xk8",
  "errorMsg": "kva7g1",
  "success": true,
  "errorNo": "o3nwld",
  "data": {},
  "time": "2023-02-13 08:31:52"
}

Curl-example:

curl -X DELETE -H 'Authorization' -i http://127.0.0.1:9010/sysPersonalitySettings/deleteOne/217

3.16.12. 11.基础批量删除物理删除

URL: http://127.0.0.1:9010/sysPersonalitySettings/deleteBatchs

Type: DELETE

Author: meng

Content-Type: application/json

Description: 11.基础批量删除物理删除

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Body-parameters:

Parameter

Type

Required

Description

ids

array

false

No comments found.,[array of int64]@since

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

└─any object

object

any object.

time

string

响应时间

Response-example:

{
  "code": 431,
  "msg": "bku9ol",
  "errorMsg": "k7uzjz",
  "success": true,
  "errorNo": "g70bw0",
  "data": {},
  "time": "2023-02-13 08:31:52"
}

Curl-example:

curl -X DELETE -H 'Content-Type: application/json' -H 'Authorization' -i http://127.0.0.1:9010/sysPersonalitySettings/deleteBatchs --data '[]'

3.16.13. 12.基础批量逻辑删除

URL: http://127.0.0.1:9010/sysPersonalitySettings/updateDeleteFlagBatchs

Type: PATCH

Author: meng

Content-Type: application/json

Description: 12.基础批量逻辑删除

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Body-parameters:

Parameter

Type

Required

Description

ids

array

false

id集合,[array of int64]@since

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

└─any object

object

any object.

time

string

响应时间

Response-example:

{
  "code": 234,
  "msg": "hjuwbg",
  "errorMsg": "jnx8y6",
  "success": true,
  "errorNo": "k8rwn9",
  "data": {},
  "time": "2023-02-13 08:31:52"
}

Curl-example:

curl -X PATCH -H 'Content-Type: application/json' -H 'Authorization' -i http://127.0.0.1:9010/sysPersonalitySettings/updateDeleteFlagBatchs --data '[]'

3.16.14. 13.基础逻辑删除

URL: http://127.0.0.1:9010/sysPersonalitySettings/updateDeleteFlag/{id}

Type: PATCH

Author: meng

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 13.基础逻辑删除

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Path-parameters:

Parameter

Value

Type

Required

Description

int64

true

No comments found.

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

└─any object

object

any object.

time

string

响应时间

Response-example:

{
  "code": 769,
  "msg": "88qite",
  "errorMsg": "ddv2tv",
  "success": true,
  "errorNo": "lfns72",
  "data": {},
  "time": "2023-02-13 08:31:52"
}

Curl-example:

curl -X PATCH -H 'Authorization' -i http://127.0.0.1:9010/sysPersonalitySettings/updateDeleteFlag/102

3.17. <pre>系统用户账号维护接口</pre>

3.17.1.

URL: http://127.0.0.1:9010/sys/users/q

Type: POST

Author: Michael Li

Content-Type: application/json

Description:

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Body-parameters:

Parameter

Type

Required

Description

current

int32

false

页码

size

int32

false

页大小

keyword

string

false

搜索关键字

orders

array

false

排序

└─column

string

false

属性名称

└─asc

boolean

false

是否升序

username

string

false

No comments found.

name

string

false

No comments found.

mobile

string

false

No comments found.

string

false

No comments found.

tenantName

string

false

No comments found.

enabled

boolean

false

No comments found.

roleIds

array

false

No comments found.

sourceType

string

false

No comments found.

transFlag

int32

false

No comments found.

Request-body:

{
  "current": 114,
  "size": 10,
  "keyword": "lpk6pw",
  "orders": [
    {
      "column": "07y8fm",
      "asc": true
    }
  ],
  "username": "marg.collier",
  "name": "marg.collier",
  "mobile": "(734) 208-3091",
  "email": "celinda.goldner@gmail.com",
  "tenantName": "marg.collier",
  "enabled": true,
  "roleIds": [
    597
  ],
  "sourceType": "is2mi5",
  "transFlag": 9
}

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

└─total

int64

总记录数

└─records

array

数据列表

└─id

int64

记录唯一ID

└─tenantId

int64

租户ID

└─remark

string

备注

└─createUserId

int64

记录创建者ID

└─creator

string

记录创建者

└─createTime

string

记录创建时间

└─modifyUserId

int64

记录最后更新者ID

└─updater

string

记录最后更新者

└─modifyTime

string

记录最后更新时间

└─deleteFlag

int32

逻辑删除标识

└─auditDataVersion

int32

锁版本

└─username

string

No comments found.

└─lastName

string

No comments found.

└─firstName

string

No comments found.

└─mobile

string

No comments found.

└─email

string

No comments found.

└─roleNames

string

No comments found.

└─roleIds

string

No comments found.

└─wxOpenid

string

No comments found.

└─tenantName

string

No comments found.

└─enabled

boolean

No comments found.

└─roles

array

No comments found.

└─id

int64

No comments found.

└─code

string

No comments found.

└─name

string

No comments found.

└─tenantName

string

No comments found.

└─enabled

boolean

No comments found.

└─users

array

No comments found.

└─id

int64

记录唯一ID

└─tenantId

int64

租户ID

└─remark

string

备注

└─createUserId

int64

记录创建者ID

└─creator

string

记录创建者

└─createTime

string

记录创建时间

└─modifyUserId

int64

记录最后更新者ID

└─updater

string

记录最后更新者

└─modifyTime

string

记录最后更新时间

└─deleteFlag

int32

逻辑删除标识

└─auditDataVersion

int32

锁版本

└─username

string

No comments found.

└─lastName

string

No comments found.

└─firstName

string

No comments found.

└─mobile

string

No comments found.

└─email

string

No comments found.

└─roleNames

string

No comments found.

└─roleIds

string

No comments found.

└─wxOpenid

string

No comments found.

└─tenantName

string

No comments found.

└─enabled

boolean

No comments found.

└─roles

array

No comments found.

└─permissions

array

No comments found.

└─id

int64

权限ID

└─code

string

权限代码

└─name

string

权限名称

└─permType

int32

权限类型: 1.菜单；0.按钮或API调用

└─parentId

int64

父权限ID

└─parentName

string

父权限名称"

└─path

string

权限层级路径

└─permLevel

int32

权限层级

└─sortNo

int32

排列顺序

└─pattern

string

URL路径

└─httpMethod

string

URL的HTTP方法

└─isHidden

boolean

菜单是否隐藏

└─icon

string

菜单图标

└─terminalCode

string

No comments found.

└─menuDepth

int32

菜单深度

└─isQuick

boolean

菜单是否隐藏

└─permIds

array

No comments found.

└─permissions

array

No comments found.

└─id

int64

权限ID

└─code

string

权限代码

└─name

string

权限名称

└─permType

int32

权限类型: 1.菜单；0.按钮或API调用

└─parentId

int64

父权限ID

└─parentName

string

父权限名称"

└─path

string

权限层级路径

└─permLevel

int32

权限层级

└─sortNo

int32

排列顺序

└─pattern

string

URL路径

└─httpMethod

string

URL的HTTP方法

└─isHidden

boolean

菜单是否隐藏

└─icon

string

菜单图标

└─terminalCode

string

No comments found.

└─menuDepth

int32

菜单深度

└─isQuick

boolean

菜单是否隐藏

└─noPermission

boolean

操作人是否有对应的权限

└─permissions

array

No comments found.

└─id

int64

权限ID

└─code

string

权限代码

└─name

string

权限名称

└─permType

int32

权限类型: 1.菜单；0.按钮或API调用

└─parentId

int64

父权限ID

└─parentName

string

父权限名称"

└─path

string

权限层级路径

└─permLevel

int32

权限层级

└─sortNo

int32

排列顺序

└─pattern

string

URL路径

└─httpMethod

string

URL的HTTP方法

└─isHidden

boolean

菜单是否隐藏

└─icon

string

菜单图标

└─terminalCode

string

No comments found.

└─menuDepth

int32

菜单深度

└─isQuick

boolean

菜单是否隐藏

time

string

响应时间

Response-example:

{
  "code": 144,
  "msg": "m9xk87",
  "errorMsg": "uj04t3",
  "success": true,
  "errorNo": "2yovok",
  "data": {
    "total": 364,
    "records": [
      {
        "id": 9,
        "tenantId": 78,
        "remark": "2g0i60",
        "createUserId": 64,
        "creator": "u3m945",
        "createTime": "2023-02-13 08:31:52",
        "modifyUserId": 664,
        "updater": "jt50t3",
        "modifyTime": "2023-02-13 08:31:52",
        "deleteFlag": 9,
        "auditDataVersion": 700,
        "username": "marg.collier",
        "lastName": "marg.collier",
        "firstName": "marg.collier",
        "mobile": "(734) 208-3091",
        "email": "celinda.goldner@gmail.com",
        "roleNames": "0l2dit",
        "roleIds": "a9nrpo",
        "wxOpenid": "173",
        "tenantName": "marg.collier",
        "enabled": true,
        "roles": [
          {
            "id": 17,
            "code": "99507",
            "name": "marg.collier",
            "tenantName": "marg.collier",
            "enabled": true,
            "users": [
              {
                "id": 318,
                "tenantId": 867,
                "remark": "fvezd7",
                "createUserId": 512,
                "creator": "3k4c0w",
                "createTime": "2023-02-13 08:31:52",
                "modifyUserId": 904,
                "updater": "fho9x9",
                "modifyTime": "2023-02-13 08:31:52",
                "deleteFlag": 9,
                "auditDataVersion": 500,
                "username": "marg.collier",
                "lastName": "marg.collier",
                "firstName": "marg.collier",
                "mobile": "(734) 208-3091",
                "email": "celinda.goldner@gmail.com",
                "roleNames": "73cfb9",
                "roleIds": "vxemqj",
                "wxOpenid": "173",
                "tenantName": "marg.collier",
                "enabled": true,
                "roles": [
                  {
                    "$ref": "..."
                  }
                ],
                "permissions": [
                  {
                    "id": 632,
                    "code": "99507",
                    "name": "marg.collier",
                    "permType": 165,
                    "parentId": 492,
                    "parentName": "marg.collier",
                    "path": "rcygye",
                    "permLevel": 543,
                    "sortNo": 299,
                    "pattern": "ojdtmf",
                    "httpMethod": "bgqe2h",
                    "isHidden": true,
                    "icon": "jafsyk",
                    "terminalCode": "99507",
                    "menuDepth": 631,
                    "isQuick": true
                  }
                ]
              }
            ],
            "permIds": [
              356
            ],
            "permissions": [
              {
                "id": 594,
                "code": "99507",
                "name": "marg.collier",
                "permType": 739,
                "parentId": 505,
                "parentName": "marg.collier",
                "path": "x6q5jz",
                "permLevel": 988,
                "sortNo": 694,
                "pattern": "xisvbo",
                "httpMethod": "nblcvt",
                "isHidden": true,
                "icon": "q23ja2",
                "terminalCode": "99507",
                "menuDepth": 776,
                "isQuick": true
              }
            ],
            "noPermission": true
          }
        ],
        "permissions": [
          {
            "id": 672,
            "code": "99507",
            "name": "marg.collier",
            "permType": 505,
            "parentId": 922,
            "parentName": "marg.collier",
            "path": "jsxhvy",
            "permLevel": 349,
            "sortNo": 785,
            "pattern": "ioetqc",
            "httpMethod": "gip5tl",
            "isHidden": true,
            "icon": "npmfnv",
            "terminalCode": "99507",
            "menuDepth": 930,
            "isQuick": true
          }
        ]
      }
    ]
  },
  "time": "2023-02-13 08:31:52"
}

Curl-example:

curl -X POST -H 'Content-Type: application/json' -H 'Authorization' -i http://127.0.0.1:9010/sys/users/q --data '{
  "current": 114,
  "size": 10,
  "keyword": "lpk6pw",
  "orders": [
    {
      "column": "07y8fm",
      "asc": true
    }
  ],
  "username": "marg.collier",
  "name": "marg.collier",
  "mobile": "(734) 208-3091",
  "email": "celinda.goldner@gmail.com",
  "tenantName": "marg.collier",
  "enabled": true,
  "roleIds": [
    597
  ],
  "sourceType": "is2mi5",
  "transFlag": 9
}'

3.17.2.

URL: http://127.0.0.1:9010/sys/users/paging

Type: POST

Author: Michael Li

Content-Type: application/json

Description:

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Body-parameters:

Parameter

Type

Required

Description

current

int32

false

页码

size

int32

false

页大小

keyword

string

false

搜索关键字

orders

array

false

排序

└─column

string

false

属性名称

└─asc

boolean

false

是否升序

username

string

false

No comments found.

name

string

false

No comments found.

mobile

string

false

No comments found.

string

false

No comments found.

tenantId

int64

false

No comments found.

tenantName

string

false

No comments found.

enabled

boolean

false

No comments found.

roleCodeName

string

false

No comments found.

dataRoleCodeName

string

false

No comments found.

flowRoleCodeName

string

false

No comments found.

ouName

string

false

No comments found.

userType

string

false

No comments found.

Request-body:

{
  "current": 635,
  "size": 10,
  "keyword": "0bzcn9",
  "orders": [
    {
      "column": "z571o2",
      "asc": true
    }
  ],
  "username": "marg.collier",
  "name": "marg.collier",
  "mobile": "(734) 208-3091",
  "email": "celinda.goldner@gmail.com",
  "tenantId": 321,
  "tenantName": "marg.collier",
  "enabled": true,
  "roleCodeName": "marg.collier",
  "dataRoleCodeName": "marg.collier",
  "flowRoleCodeName": "marg.collier",
  "ouName": "marg.collier",
  "userType": "osltlg"
}

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

└─total

int64

总记录数

└─records

array

数据列表

└─id

int64

用户ID

└─username

string

用户账号

└─lastName

string

用户姓氏

└─firstName

string

用户名称

└─mobile

string

手机号

└─email

string

电子邮箱

└─roleNames

string

角色名称列表

└─dataRoleNames

string

角色名称列表

└─flowRoleNames

string

流程角色名称列表

└─enabled

boolean

用户账号启用状态

└─ouId

int64

用户所属公司ID

└─ouCode

string

用户所属公司编号

└─ouName

string

用户所属公司名称

└─tenantId

int64

No comments found.

└─tenantName

string

No comments found.

└─buId

int64

用户所属组织ID

time

string

响应时间

Response-example:

{
  "code": 185,
  "msg": "liktlt",
  "errorMsg": "6nzwwv",
  "success": true,
  "errorNo": "ne3a75",
  "data": {
    "total": 431,
    "records": [
      {
        "id": 68,
        "username": "marg.collier",
        "lastName": "marg.collier",
        "firstName": "marg.collier",
        "mobile": "(734) 208-3091",
        "email": "celinda.goldner@gmail.com",
        "roleNames": "5tirpb",
        "dataRoleNames": "a0hzif",
        "flowRoleNames": "hsi13l",
        "enabled": true,
        "ouId": 582,
        "ouCode": "99507",
        "ouName": "marg.collier",
        "tenantId": 837,
        "tenantName": "marg.collier",
        "buId": 986
      }
    ]
  },
  "time": "2023-02-13 08:31:52"
}

Curl-example:

curl -X POST -H 'Content-Type: application/json' -H 'Authorization' -i http://127.0.0.1:9010/sys/users/paging --data '{
  "current": 635,
  "size": 10,
  "keyword": "0bzcn9",
  "orders": [
    {
      "column": "z571o2",
      "asc": true
    }
  ],
  "username": "marg.collier",
  "name": "marg.collier",
  "mobile": "(734) 208-3091",
  "email": "celinda.goldner@gmail.com",
  "tenantId": 321,
  "tenantName": "marg.collier",
  "enabled": true,
  "roleCodeName": "marg.collier",
  "dataRoleCodeName": "marg.collier",
  "flowRoleCodeName": "marg.collier",
  "ouName": "marg.collier",
  "userType": "osltlg"
}'

3.17.3.

URL: http://127.0.0.1:9010/sys/users/

Type: POST

Author: Michael Li

Content-Type: application/json

Description:

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Body-parameters:

Parameter

Type

Required

Description

username

string

false

用户账号名称

lastName

string

false

用户姓氏

firstName

string

false

用户名称

mobile

string

false

用户手机号码

string

false

用户邮箱地址

enabled

boolean

false

是否启用

ouId

int64

false

用户所属公司ID

ouCode

string

false

用户所属公司编号

ouName

string

false

用户所属公司名称

buId

int64

false

用户所属组织ID

tenantId

int64

false

No comments found.

tenantName

string

false

No comments found.

userType

string

false

No comments found.

roleIds

array

false

功能角色ID列表

dataRoleIds

array

false

数据角色ID列表

flowRoleIds

array

false

流程角色ID列表

sourceType

string

false

Mir 2020-09-15 增加账号信息来源字段，默认sys，由系统创建

terminals

array

false

用户终端
可登录的端
BACKEND
APP
APPLET

Request-body:

{
  "username": "marg.collier",
  "lastName": "marg.collier",
  "firstName": "marg.collier",
  "mobile": "(734) 208-3091",
  "email": "celinda.goldner@gmail.com",
  "enabled": true,
  "ouId": 734,
  "ouCode": "99507",
  "ouName": "marg.collier",
  "buId": 541,
  "tenantId": 979,
  "tenantName": "marg.collier",
  "userType": "2q54p8",
  "roleIds": [
    840
  ],
  "dataRoleIds": [
    739
  ],
  "flowRoleIds": [
    457
  ],
  "sourceType": "3s814n",
  "terminals": [
    "BACKEND"
  ]
}

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

string

响应数据

time

string

响应时间

Response-example:

{
  "code": 978,
  "msg": "fj0oyq",
  "errorMsg": "joate6",
  "success": true,
  "errorNo": "caqalv",
  "data": "3822ip",
  "time": "2023-02-13 08:31:52"
}

Curl-example:

curl -X POST -H 'Content-Type: application/json' -H 'Authorization' -i http://127.0.0.1:9010/sys/users/ --data '{
  "username": "marg.collier",
  "lastName": "marg.collier",
  "firstName": "marg.collier",
  "mobile": "(734) 208-3091",
  "email": "celinda.goldner@gmail.com",
  "enabled": true,
  "ouId": 734,
  "ouCode": "99507",
  "ouName": "marg.collier",
  "buId": 541,
  "tenantId": 979,
  "tenantName": "marg.collier",
  "userType": "2q54p8",
  "roleIds": [
    840
  ],
  "dataRoleIds": [
    739
  ],
  "flowRoleIds": [
    457
  ],
  "sourceType": "3s814n",
  "terminals": [
    "BACKEND"
  ]
}'

3.17.4.

URL: http://127.0.0.1:9010/sys/users/

Type: PUT

Author: Michael Li

Content-Type: application/json

Description:

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Body-parameters:

Parameter

Type

Required

Description

int64

false

用户ID

lastName

string

false

用户姓氏

userName

string

false

用户姓氏

firstName

string

false

用户名称

mobile

string

false

用户手机号码

string

false

用户邮箱地址

tenantId

string

false

No comments found.

tenantName

string

false

No comments found.

enabled

boolean

false

是否启动

ouId

int64

false

用户所属公司ID

ouCode

string

false

用户所属公司编号

ouName

string

false

用户所属公司名称

buId

int64

false

用户所属组织ID

roleIds

array

false

功能角色ID列表

dataRoleIds

array

false

数据角色ID列表

flowRoleIds

array

false

流程角色ID列表

terminals

array

false

用户终端
可登录的端
BACKEND
APP
APPLET

roleName

string

false

No comments found.

password

string

false

No comments found.

Request-body:

{
  "id": 684,
  "lastName": "marg.collier",
  "userName": "marg.collier",
  "firstName": "marg.collier",
  "mobile": "(734) 208-3091",
  "email": "celinda.goldner@gmail.com",
  "tenantId": "173",
  "tenantName": "marg.collier",
  "enabled": true,
  "ouId": 824,
  "ouCode": "99507",
  "ouName": "marg.collier",
  "buId": 900,
  "roleIds": [
    903
  ],
  "dataRoleIds": [
    520
  ],
  "flowRoleIds": [
    840
  ],
  "terminals": [
    "BACKEND"
  ],
  "roleName": "marg.collier",
  "password": "rowlvn"
}

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

boolean

响应数据

time

string

响应时间

Response-example:

{
  "code": 229,
  "msg": "9ipioe",
  "errorMsg": "vah6wx",
  "success": true,
  "errorNo": "9fjzwc",
  "data": true,
  "time": "2023-02-13 08:31:52"
}

Curl-example:

curl -X PUT -H 'Content-Type: application/json' -H 'Authorization' -i http://127.0.0.1:9010/sys/users/ --data '{
  "id": 684,
  "lastName": "marg.collier",
  "userName": "marg.collier",
  "firstName": "marg.collier",
  "mobile": "(734) 208-3091",
  "email": "celinda.goldner@gmail.com",
  "tenantId": "173",
  "tenantName": "marg.collier",
  "enabled": true,
  "ouId": 824,
  "ouCode": "99507",
  "ouName": "marg.collier",
  "buId": 900,
  "roleIds": [
    903
  ],
  "dataRoleIds": [
    520
  ],
  "flowRoleIds": [
    840
  ],
  "terminals": [
    "BACKEND"
  ],
  "roleName": "marg.collier",
  "password": "rowlvn"
}'

3.17.5.

URL: http://127.0.0.1:9010/sys/users/details/{id}

Type: GET

Author: Michael Li

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description:

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Path-parameters:

Parameter

Value

Type

Required

Description

int64

true

No comments found.

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

└─id

int64

用户ID

└─lastName

string

用户姓氏

└─firstName

string

用户名称

└─mobile

string

用户手机号码

└─email

string

用户邮箱地址

└─password

string

用户账号密码

└─enabled

boolean

是否启动

└─ouId

int64

用户所属公司ID

└─ouCode

string

用户所属公司编号

└─ouName

string

用户所属公司名称

└─buId

int64

用户所属组织ID

└─roleIds

array

功能角色ID列表

└─dataRoleIds

array

数据角色ID列表

└─flowRoleIds

array

流程角色ID列表

└─avatarUrl

string

No comments found.

└─avatarCode

string

No comments found.

└─terminals

array

用户的终端
BACKEND
APP
APPLET

time

string

响应时间

Response-example:

{
  "code": 748,
  "msg": "w73w3o",
  "errorMsg": "0igfvs",
  "success": true,
  "errorNo": "lzr1q5",
  "data": {
    "id": 727,
    "lastName": "marg.collier",
    "firstName": "marg.collier",
    "mobile": "(734) 208-3091",
    "email": "celinda.goldner@gmail.com",
    "password": "5yfqo1",
    "enabled": true,
    "ouId": 887,
    "ouCode": "99507",
    "ouName": "marg.collier",
    "buId": 139,
    "roleIds": [
      "7ggpn9"
    ],
    "dataRoleIds": [
      "mw60l7"
    ],
    "flowRoleIds": [
      "s9me3j"
    ],
    "avatarUrl": "www.williams-bashirian.biz",
    "avatarCode": "99507",
    "terminals": [
      "BACKEND"
    ]
  },
  "time": "2023-02-13 08:31:52"
}

Curl-example:

curl -X GET -H 'Authorization' -i http://127.0.0.1:9010/sys/users/details/500

3.17.6.

URL: http://127.0.0.1:9010/sys/users/{id}

Type: GET

Author: Michael Li

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description:

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Path-parameters:

Parameter

Value

Type

Required

Description

int64

true

No comments found.

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

└─id

int64

加上：@JsonSerialize(using = ToStringSerializer.class)并不能把long转为字符串，
目前通过SysUserDTO转为SysUserVO

└─tenantId

int64

No comments found.

└─ouId

int64

所属公司ID

└─ouCode

string

公司编码

└─ouName

string

公司名称

└─remark

string

No comments found.

└─createUserId

int64

No comments found.

└─creator

string

No comments found.

└─createTime

string

No comments found.

└─modifyUserId

int64

No comments found.

└─updater

string

No comments found.

└─modifyTime

string

No comments found.

└─deleteFlag

int32

No comments found.

└─auditDataVersion

int32

No comments found.

└─username

string

No comments found.

└─lastName

string

No comments found.

└─firstName

string

No comments found.

└─mobile

string

No comments found.

└─email

string

No comments found.

└─password

string

No comments found.

└─wxOpenid

string

No comments found.

└─sourceType

string

Mir 2020-09-15 增加账号信息来源字段，默认sys，由系统创建

└─enabled

boolean

No comments found.

└─needReset

boolean

No comments found.

└─transFlag

int32

No comments found.

└─roles

array

No comments found.

└─id

int64

No comments found.

└─code

string

No comments found.

└─name

string

No comments found.

└─tenantName

string

No comments found.

└─enabled

boolean

No comments found.

└─users

array

No comments found.

└─id

int64

记录唯一ID

└─tenantId

int64

租户ID

└─remark

string

备注

└─createUserId

int64

记录创建者ID

└─creator

string

记录创建者

└─createTime

string

记录创建时间

└─modifyUserId

int64

记录最后更新者ID

└─updater

string

记录最后更新者

└─modifyTime

string

记录最后更新时间

└─deleteFlag

int32

逻辑删除标识

└─auditDataVersion

int32

锁版本

└─username

string

No comments found.

└─lastName

string

No comments found.

└─firstName

string

No comments found.

└─mobile

string

No comments found.

└─email

string

No comments found.

└─roleNames

string

No comments found.

└─roleIds

string

No comments found.

└─wxOpenid

string

No comments found.

└─tenantName

string

No comments found.

└─enabled

boolean

No comments found.

└─roles

array

No comments found.

└─id

int64

No comments found.

└─code

string

No comments found.

└─name

string

No comments found.

└─tenantName

string

No comments found.

└─enabled

boolean

No comments found.

└─users

array

No comments found.

└─permIds

array

No comments found.

└─permissions

array

No comments found.

└─id

int64

权限ID

└─code

string

权限代码

└─name

string

权限名称

└─permType

int32

权限类型: 1.菜单；0.按钮或API调用

└─parentId

int64

父权限ID

└─parentName

string

父权限名称"

└─path

string

权限层级路径

└─permLevel

int32

权限层级

└─sortNo

int32

排列顺序

└─pattern

string

URL路径

└─httpMethod

string

URL的HTTP方法

└─isHidden

boolean

菜单是否隐藏

└─icon

string

菜单图标

└─terminalCode

string

No comments found.

└─menuDepth

int32

菜单深度

└─isQuick

boolean

菜单是否隐藏

└─noPermission

boolean

操作人是否有对应的权限

└─permissions

array

No comments found.

└─id

int64

权限ID

└─code

string

权限代码

└─name

string

权限名称

└─permType

int32

权限类型: 1.菜单；0.按钮或API调用

└─parentId

int64

父权限ID

└─parentName

string

父权限名称"

└─path

string

权限层级路径

└─permLevel

int32

权限层级

└─sortNo

int32

排列顺序

└─pattern

string

URL路径

└─httpMethod

string

URL的HTTP方法

└─isHidden

boolean

菜单是否隐藏

└─icon

string

菜单图标

└─terminalCode

string

No comments found.

└─menuDepth

int32

菜单深度

└─isQuick

boolean

菜单是否隐藏

└─permIds

array

No comments found.

└─permissions

array

No comments found.

└─id

int64

权限ID

└─code

string

权限代码

└─name

string

权限名称

└─permType

int32

权限类型: 1.菜单；0.按钮或API调用

└─parentId

int64

父权限ID

└─parentName

string

父权限名称"

└─path

string

权限层级路径

└─permLevel

int32

权限层级

└─sortNo

int32

排列顺序

└─pattern

string

URL路径

└─httpMethod

string

URL的HTTP方法

└─isHidden

boolean

菜单是否隐藏

└─icon

string

菜单图标

└─terminalCode

string

No comments found.

└─menuDepth

int32

菜单深度

└─isQuick

boolean

菜单是否隐藏

└─noPermission

boolean

操作人是否有对应的权限

└─permissions

map

No comments found.

└─id

int64

权限ID

└─code

string

权限代码

└─name

string

权限名称

└─permType

int32

权限类型: 1.菜单；0.按钮或API调用

└─parentId

int64

父权限ID

└─parentName

string

父权限名称"

└─path

string

权限层级路径

└─permLevel

int32

权限层级

└─sortNo

int32

排列顺序

└─pattern

string

URL路径

└─httpMethod

string

URL的HTTP方法

└─isHidden

boolean

菜单是否隐藏

└─icon

string

菜单图标

└─terminalCode

string

No comments found.

└─menuDepth

int32

菜单深度

└─isQuick

boolean

菜单是否隐藏

└─sysDataRoleVOS

array

No comments found.

└─id

int64

No comments found.

└─code

string

No comments found.

└─name

string

No comments found.

└─enabled

boolean

No comments found.

└─advancedEnable

boolean

No comments found.

└─businessEnable

boolean

No comments found.

└─sysDataAuthVO

object

No comments found.

└─isAll

boolean

是不是全部查看

└─buAuthEnable

boolean

是否启用组织授权

└─buDataAuthScope

enum

组织授权方式
ALL
SELF
SELF_CHILDES

└─empAuthEnable

boolean

是否启用员工授权

└─userDataAuthScope

enum

员工授权方式
ALL
SELF
SELF_CHILDES

└─ouAuthEnable

boolean

是否启用公司授权

└─dataRoleId

int64

关联的数据角色ID

└─isBasic

boolean

是否基础数据授权：1 是，0 否

└─permissionId

int64

高级授权应用ID

└─permissionCode

string

高级授权应用Code

└─buIdSet

array

自定义授权的组织id

└─userIdSet

array

自定义授权的账号id

└─ouIdSet

array

自定义授权的公司id

└─stringSysDataPermissionVOMap

map

No comments found.

└─isAll

boolean

是不是全部查看

└─buAuthEnable

boolean

是否启用组织授权

└─buDataAuthScope

enum

组织授权方式
ALL
SELF
SELF_CHILDES

└─empAuthEnable

boolean

是否启用员工授权

└─userDataAuthScope

enum

员工授权方式
ALL
SELF
SELF_CHILDES

└─ouAuthEnable

boolean

是否启用公司授权

└─dataRoleId

int64

关联的数据角色ID

└─isBasic

boolean

是否基础数据授权：1 是，0 否

└─permissionId

int64

高级授权应用ID

└─permissionCode

string

高级授权应用Code

└─buIdSet

array

自定义授权的组织id

└─userIdSet

array

自定义授权的账号id

└─ouIdSet

array

自定义授权的公司id

└─sysBizDataConstraintVO

array

No comments found.

└─metaColumnId

int64

No comments found.

└─dataRoleCode

string

No comments found.

└─dataRoleName

string

No comments found.

└─domainCode

string

No comments found.

└─domainName

string

No comments found.

└─tableCode

string

No comments found.

└─tableName

string

No comments found.

└─fieldCode

string

No comments found.

└─fieldCaption

string

No comments found.

└─fieldType

string

No comments found.

└─fieldUdcType

string

No comments found.

└─udcDomainCode

string

No comments found.

└─udcCode

string

No comments found.

└─defaultValue

string

No comments found.

└─compareOpCode

string

No comments found.

└─compareOpName

string

No comments found.

└─constraintValues

string

No comments found.

└─avatarUrl

string

用户头像地址

└─avatarCode

string

用户头像的文件编码

└─terminals

array

用户的终端
BACKEND
APP
APPLET

└─sysTenantVO

object

用户当前的租户

└─id

int64

记录唯一ID

└─tenantCode

string

租户编号

└─tenantName

string

租户名称

└─sysUserId

int64

租户管理员ID

└─type

enum

租户类型
COMMON
OPERATION

└─isolationStrategy

enum

租户数据隔离策略，目前仅支持SCHEMA
DATABASE
SCHEMA
FIELD

└─dbInitialized

boolean

租户数据库是否已初始化

└─tenantDomain

string

域名地址

└─customDomain

string

租户自己的域名地址

└─databaseSourceId

int64

租户数据隔离数据源

└─schemaName

string

schema名称，支持英文字母、数字和下划线

└─industry

string

所属行业，[UDC]COM:INDUSTRY

└─customer

string

所属客户，[UDC]SYS:CUSTOMER

└─sysTenantDTOList

array

用户所有的租户

└─id

int64

记录唯一ID

└─tenantCode

string

租户编号

└─tenantName

string

租户名称

└─sysUserId

int64

租户管理员ID

└─type

enum

租户类型
COMMON
OPERATION

└─isolationStrategy

enum

租户数据隔离策略，目前仅支持SCHEMA
DATABASE
SCHEMA
FIELD

└─dbInitialized

boolean

租户数据库是否已初始化

└─tenantDomain

string

域名地址

└─customDomain

string

租户自己的域名地址

└─databaseSourceId

int64

租户数据隔离数据源

└─schemaName

string

schema名称，支持英文字母、数字和下划线

└─industry

string

所属行业，[UDC]COM:INDUSTRY

└─customer

string

所属客户，[UDC]SYS:CUSTOMER

time

string

响应时间

Response-example:

{
  "code": 686,
  "msg": "gqr8sv",
  "errorMsg": "i7homd",
  "success": true,
  "errorNo": "7t2hjx",
  "data": {
    "id": 606,
    "tenantId": 763,
    "ouId": 974,
    "ouCode": "99507",
    "ouName": "marg.collier",
    "remark": "ixk2oe",
    "createUserId": 792,
    "creator": "1o8kt3",
    "createTime": "2023-02-13 08:31:52",
    "modifyUserId": 777,
    "updater": "sl1su9",
    "modifyTime": "2023-02-13 08:31:52",
    "deleteFlag": 9,
    "auditDataVersion": 282,
    "username": "marg.collier",
    "lastName": "marg.collier",
    "firstName": "marg.collier",
    "mobile": "(734) 208-3091",
    "email": "celinda.goldner@gmail.com",
    "password": "6hn8kr",
    "wxOpenid": "173",
    "sourceType": "n0yf7w",
    "enabled": true,
    "needReset": true,
    "transFlag": 9,
    "roles": [
      {
        "id": 436,
        "code": "99507",
        "name": "marg.collier",
        "tenantName": "marg.collier",
        "enabled": true,
        "users": [
          {
            "id": 751,
            "tenantId": 897,
            "remark": "ual4cf",
            "createUserId": 588,
            "creator": "8ok63g",
            "createTime": "2023-02-13 08:31:52",
            "modifyUserId": 575,
            "updater": "a1pfwk",
            "modifyTime": "2023-02-13 08:31:52",
            "deleteFlag": 9,
            "auditDataVersion": 692,
            "username": "marg.collier",
            "lastName": "marg.collier",
            "firstName": "marg.collier",
            "mobile": "(734) 208-3091",
            "email": "celinda.goldner@gmail.com",
            "roleNames": "fl05zq",
            "roleIds": "5hx22w",
            "wxOpenid": "173",
            "tenantName": "marg.collier",
            "enabled": true,
            "roles": [
              {
                "id": 900,
                "code": "99507",
                "name": "marg.collier",
                "tenantName": "marg.collier",
                "enabled": true,
                "users": [
                  {
                    "$ref": "..."
                  }
                ],
                "permIds": [
                  751
                ],
                "permissions": [
                  {
                    "id": 679,
                    "code": "99507",
                    "name": "marg.collier",
                    "permType": 575,
                    "parentId": 144,
                    "parentName": "marg.collier",
                    "path": "tb3fue",
                    "permLevel": 502,
                    "sortNo": 829,
                    "pattern": "x8gruo",
                    "httpMethod": "umyhto",
                    "isHidden": true,
                    "icon": "sztx4f",
                    "terminalCode": "99507",
                    "menuDepth": 71,
                    "isQuick": true
                  }
                ],
                "noPermission": true
              }
            ],
            "permissions": [
              {
                "id": 616,
                "code": "99507",
                "name": "marg.collier",
                "permType": 844,
                "parentId": 43,
                "parentName": "marg.collier",
                "path": "t36tx6",
                "permLevel": 878,
                "sortNo": 369,
                "pattern": "d8rsx9",
                "httpMethod": "rnkyjk",
                "isHidden": true,
                "icon": "cof84c",
                "terminalCode": "99507",
                "menuDepth": 225,
                "isQuick": true
              }
            ]
          }
        ],
        "permIds": [
          620
        ],
        "permissions": [
          {
            "id": 305,
            "code": "99507",
            "name": "marg.collier",
            "permType": 805,
            "parentId": 866,
            "parentName": "marg.collier",
            "path": "r6bshd",
            "permLevel": 701,
            "sortNo": 182,
            "pattern": "hooczv",
            "httpMethod": "9brlbw",
            "isHidden": true,
            "icon": "7yq9xr",
            "terminalCode": "99507",
            "menuDepth": 441,
            "isQuick": true
          }
        ],
        "noPermission": true
      }
    ],
    "permissions": {
      "mapKey": {}
    },
    "sysDataRoleVOS": [
      {
        "id": 72,
        "code": "99507",
        "name": "marg.collier",
        "enabled": true,
        "advancedEnable": true,
        "businessEnable": true,
        "sysDataAuthVO": {
          "isAll": true,
          "buAuthEnable": true,
          "buDataAuthScope": "ALL",
          "empAuthEnable": true,
          "userDataAuthScope": "ALL",
          "ouAuthEnable": true,
          "dataRoleId": 377,
          "isBasic": true,
          "permissionId": 341,
          "permissionCode": "99507",
          "buIdSet": [
            118
          ],
          "userIdSet": [
            982
          ],
          "ouIdSet": [
            810
          ]
        },
        "stringSysDataPermissionVOMap": {
          "mapKey": {
            "isAll": true,
            "buAuthEnable": true,
            "buDataAuthScope": "ALL",
            "empAuthEnable": true,
            "userDataAuthScope": "ALL",
            "ouAuthEnable": true,
            "dataRoleId": 90,
            "isBasic": true,
            "permissionId": 551,
            "permissionCode": "99507",
            "buIdSet": [
              714
            ],
            "userIdSet": [
              883
            ],
            "ouIdSet": [
              160
            ]
          }
        },
        "sysBizDataConstraintVO": [
          {
            "metaColumnId": 887,
            "dataRoleCode": "99507",
            "dataRoleName": "marg.collier",
            "domainCode": "99507",
            "domainName": "marg.collier",
            "tableCode": "99507",
            "tableName": "marg.collier",
            "fieldCode": "99507",
            "fieldCaption": "mtocu7",
            "fieldType": "0ka3f8",
            "fieldUdcType": "08ysg9",
            "udcDomainCode": "99507",
            "udcCode": "99507",
            "defaultValue": "hhx6cw",
            "compareOpCode": "99507",
            "compareOpName": "marg.collier",
            "constraintValues": "g65yhb"
          }
        ]
      }
    ],
    "avatarUrl": "www.williams-bashirian.biz",
    "avatarCode": "99507",
    "terminals": [
      "BACKEND"
    ],
    "sysTenantVO": {
      "id": 473,
      "tenantCode": "99507",
      "tenantName": "marg.collier",
      "sysUserId": 558,
      "type": "COMMON",
      "isolationStrategy": "DATABASE",
      "dbInitialized": true,
      "tenantDomain": "marquardt.org",
      "customDomain": "marquardt.org",
      "databaseSourceId": 916,
      "schemaName": "marg.collier",
      "industry": "mlssi2",
      "customer": "csgtuk"
    },
    "sysTenantDTOList": [
      {
        "id": 183,
        "tenantCode": "99507",
        "tenantName": "marg.collier",
        "sysUserId": 583,
        "type": "COMMON",
        "isolationStrategy": "DATABASE",
        "dbInitialized": true,
        "tenantDomain": "marquardt.org",
        "customDomain": "marquardt.org",
        "databaseSourceId": 703,
        "schemaName": "marg.collier",
        "industry": "u4jweu",
        "customer": "11t0ba"
      }
    ]
  },
  "time": "2023-02-13 08:31:52"
}

Curl-example:

curl -X GET -H 'Authorization' -i http://127.0.0.1:9010/sys/users/398

3.17.7.

URL: http://127.0.0.1:9010/sys/users/current

Type: GET

Author: Michael Li

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description:

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

└─id

int64

加上：@JsonSerialize(using = ToStringSerializer.class)并不能把long转为字符串，
目前通过SysUserDTO转为SysUserVO

└─tenantId

int64

No comments found.

└─ouId

int64

所属公司ID

└─ouCode

string

公司编码

└─ouName

string

公司名称

└─remark

string

No comments found.

└─createUserId

int64

No comments found.

└─creator

string

No comments found.

└─createTime

string

No comments found.

└─modifyUserId

int64

No comments found.

└─updater

string

No comments found.

└─modifyTime

string

No comments found.

└─deleteFlag

int32

No comments found.

└─auditDataVersion

int32

No comments found.

└─username

string

No comments found.

└─lastName

string

No comments found.

└─firstName

string

No comments found.

└─mobile

string

No comments found.

└─email

string

No comments found.

└─password

string

No comments found.

└─wxOpenid

string

No comments found.

└─sourceType

string

Mir 2020-09-15 增加账号信息来源字段，默认sys，由系统创建

└─enabled

boolean

No comments found.

└─needReset

boolean

No comments found.

└─transFlag

int32

No comments found.

└─roles

array

No comments found.

└─id

int64

No comments found.

└─code

string

No comments found.

└─name

string

No comments found.

└─tenantName

string

No comments found.

└─enabled

boolean

No comments found.

└─users

array

No comments found.

└─id

int64

记录唯一ID

└─tenantId

int64

租户ID

└─remark

string

备注

└─createUserId

int64

记录创建者ID

└─creator

string

记录创建者

└─createTime

string

记录创建时间

└─modifyUserId

int64

记录最后更新者ID

└─updater

string

记录最后更新者

└─modifyTime

string

记录最后更新时间

└─deleteFlag

int32

逻辑删除标识

└─auditDataVersion

int32

锁版本

└─username

string

No comments found.

└─lastName

string

No comments found.

└─firstName

string

No comments found.

└─mobile

string

No comments found.

└─email

string

No comments found.

└─roleNames

string

No comments found.

└─roleIds

string

No comments found.

└─wxOpenid

string

No comments found.

└─tenantName

string

No comments found.

└─enabled

boolean

No comments found.

└─roles

array

No comments found.

└─id

int64

No comments found.

└─code

string

No comments found.

└─name

string

No comments found.

└─tenantName

string

No comments found.

└─enabled

boolean

No comments found.

└─users

array

No comments found.

└─permIds

array

No comments found.

└─permissions

array

No comments found.

└─id

int64

权限ID

└─code

string

权限代码

└─name

string

权限名称

└─permType

int32

权限类型: 1.菜单；0.按钮或API调用

└─parentId

int64

父权限ID

└─parentName

string

父权限名称"

└─path

string

权限层级路径

└─permLevel

int32

权限层级

└─sortNo

int32

排列顺序

└─pattern

string

URL路径

└─httpMethod

string

URL的HTTP方法

└─isHidden

boolean

菜单是否隐藏

└─icon

string

菜单图标

└─terminalCode

string

No comments found.

└─menuDepth

int32

菜单深度

└─isQuick

boolean

菜单是否隐藏

└─noPermission

boolean

操作人是否有对应的权限

└─permissions

array

No comments found.

└─id

int64

权限ID

└─code

string

权限代码

└─name

string

权限名称

└─permType

int32

权限类型: 1.菜单；0.按钮或API调用

└─parentId

int64

父权限ID

└─parentName

string

父权限名称"

└─path

string

权限层级路径

└─permLevel

int32

权限层级

└─sortNo

int32

排列顺序

└─pattern

string

URL路径

└─httpMethod

string

URL的HTTP方法

└─isHidden

boolean

菜单是否隐藏

└─icon

string

菜单图标

└─terminalCode

string

No comments found.

└─menuDepth

int32

菜单深度

└─isQuick

boolean

菜单是否隐藏

└─permIds

array

No comments found.

└─permissions

array

No comments found.

└─id

int64

权限ID

└─code

string

权限代码

└─name

string

权限名称

└─permType

int32

权限类型: 1.菜单；0.按钮或API调用

└─parentId

int64

父权限ID

└─parentName

string

父权限名称"

└─path

string

权限层级路径

└─permLevel

int32

权限层级

└─sortNo

int32

排列顺序

└─pattern

string

URL路径

└─httpMethod

string

URL的HTTP方法

└─isHidden

boolean

菜单是否隐藏

└─icon

string

菜单图标

└─terminalCode

string

No comments found.

└─menuDepth

int32

菜单深度

└─isQuick

boolean

菜单是否隐藏

└─noPermission

boolean

操作人是否有对应的权限

└─permissions

map

No comments found.

└─id

int64

权限ID

└─code

string

权限代码

└─name

string

权限名称

└─permType

int32

权限类型: 1.菜单；0.按钮或API调用

└─parentId

int64

父权限ID

└─parentName

string

父权限名称"

└─path

string

权限层级路径

└─permLevel

int32

权限层级

└─sortNo

int32

排列顺序

└─pattern

string

URL路径

└─httpMethod

string

URL的HTTP方法

└─isHidden

boolean

菜单是否隐藏

└─icon

string

菜单图标

└─terminalCode

string

No comments found.

└─menuDepth

int32

菜单深度

└─isQuick

boolean

菜单是否隐藏

└─sysDataRoleVOS

array

No comments found.

└─id

int64

No comments found.

└─code

string

No comments found.

└─name

string

No comments found.

└─enabled

boolean

No comments found.

└─advancedEnable

boolean

No comments found.

└─businessEnable

boolean

No comments found.

└─sysDataAuthVO

object

No comments found.

└─isAll

boolean

是不是全部查看

└─buAuthEnable

boolean

是否启用组织授权

└─buDataAuthScope

enum

组织授权方式
ALL
SELF
SELF_CHILDES

└─empAuthEnable

boolean

是否启用员工授权

└─userDataAuthScope

enum

员工授权方式
ALL
SELF
SELF_CHILDES

└─ouAuthEnable

boolean

是否启用公司授权

└─dataRoleId

int64

关联的数据角色ID

└─isBasic

boolean

是否基础数据授权：1 是，0 否

└─permissionId

int64

高级授权应用ID

└─permissionCode

string

高级授权应用Code

└─buIdSet

array

自定义授权的组织id

└─userIdSet

array

自定义授权的账号id

└─ouIdSet

array

自定义授权的公司id

└─stringSysDataPermissionVOMap

map

No comments found.

└─isAll

boolean

是不是全部查看

└─buAuthEnable

boolean

是否启用组织授权

└─buDataAuthScope

enum

组织授权方式
ALL
SELF
SELF_CHILDES

└─empAuthEnable

boolean

是否启用员工授权

└─userDataAuthScope

enum

员工授权方式
ALL
SELF
SELF_CHILDES

└─ouAuthEnable

boolean

是否启用公司授权

└─dataRoleId

int64

关联的数据角色ID

└─isBasic

boolean

是否基础数据授权：1 是，0 否

└─permissionId

int64

高级授权应用ID

└─permissionCode

string

高级授权应用Code

└─buIdSet

array

自定义授权的组织id

└─userIdSet

array

自定义授权的账号id

└─ouIdSet

array

自定义授权的公司id

└─sysBizDataConstraintVO

array

No comments found.

└─metaColumnId

int64

No comments found.

└─dataRoleCode

string

No comments found.

└─dataRoleName

string

No comments found.

└─domainCode

string

No comments found.

└─domainName

string

No comments found.

└─tableCode

string

No comments found.

└─tableName

string

No comments found.

└─fieldCode

string

No comments found.

└─fieldCaption

string

No comments found.

└─fieldType

string

No comments found.

└─fieldUdcType

string

No comments found.

└─udcDomainCode

string

No comments found.

└─udcCode

string

No comments found.

└─defaultValue

string

No comments found.

└─compareOpCode

string

No comments found.

└─compareOpName

string

No comments found.

└─constraintValues

string

No comments found.

└─avatarUrl

string

用户头像地址

└─avatarCode

string

用户头像的文件编码

└─terminals

array

用户的终端
BACKEND
APP
APPLET

└─sysTenantVO

object

用户当前的租户

└─id

int64

记录唯一ID

└─tenantCode

string

租户编号

└─tenantName

string

租户名称

└─sysUserId

int64

租户管理员ID

└─type

enum

租户类型
COMMON
OPERATION

└─isolationStrategy

enum

租户数据隔离策略，目前仅支持SCHEMA
DATABASE
SCHEMA
FIELD

└─dbInitialized

boolean

租户数据库是否已初始化

└─tenantDomain

string

域名地址

└─customDomain

string

租户自己的域名地址

└─databaseSourceId

int64

租户数据隔离数据源

└─schemaName

string

schema名称，支持英文字母、数字和下划线

└─industry

string

所属行业，[UDC]COM:INDUSTRY

└─customer

string

所属客户，[UDC]SYS:CUSTOMER

└─sysTenantDTOList

array

用户所有的租户

└─id

int64

记录唯一ID

└─tenantCode

string

租户编号

└─tenantName

string

租户名称

└─sysUserId

int64

租户管理员ID

└─type

enum

租户类型
COMMON
OPERATION

└─isolationStrategy

enum

租户数据隔离策略，目前仅支持SCHEMA
DATABASE
SCHEMA
FIELD

└─dbInitialized

boolean

租户数据库是否已初始化

└─tenantDomain

string

域名地址

└─customDomain

string

租户自己的域名地址

└─databaseSourceId

int64

租户数据隔离数据源

└─schemaName

string

schema名称，支持英文字母、数字和下划线

└─industry

string

所属行业，[UDC]COM:INDUSTRY

└─customer

string

所属客户，[UDC]SYS:CUSTOMER

time

string

响应时间

Response-example:

{
  "code": 233,
  "msg": "ow95r1",
  "errorMsg": "119mw2",
  "success": true,
  "errorNo": "eudsnk",
  "data": {
    "id": 80,
    "tenantId": 936,
    "ouId": 210,
    "ouCode": "99507",
    "ouName": "marg.collier",
    "remark": "em4ppl",
    "createUserId": 203,
    "creator": "2pgq8h",
    "createTime": "2023-02-13 08:31:52",
    "modifyUserId": 153,
    "updater": "zrtpsi",
    "modifyTime": "2023-02-13 08:31:52",
    "deleteFlag": 9,
    "auditDataVersion": 350,
    "username": "marg.collier",
    "lastName": "marg.collier",
    "firstName": "marg.collier",
    "mobile": "(734) 208-3091",
    "email": "celinda.goldner@gmail.com",
    "password": "gk2tiy",
    "wxOpenid": "173",
    "sourceType": "4mc8r2",
    "enabled": true,
    "needReset": true,
    "transFlag": 9,
    "roles": [
      {
        "id": 651,
        "code": "99507",
        "name": "marg.collier",
        "tenantName": "marg.collier",
        "enabled": true,
        "users": [
          {
            "id": 915,
            "tenantId": 8,
            "remark": "dmo69u",
            "createUserId": 277,
            "creator": "n5d22b",
            "createTime": "2023-02-13 08:31:52",
            "modifyUserId": 534,
            "updater": "4ou0dl",
            "modifyTime": "2023-02-13 08:31:52",
            "deleteFlag": 9,
            "auditDataVersion": 937,
            "username": "marg.collier",
            "lastName": "marg.collier",
            "firstName": "marg.collier",
            "mobile": "(734) 208-3091",
            "email": "celinda.goldner@gmail.com",
            "roleNames": "m678ny",
            "roleIds": "2o0exa",
            "wxOpenid": "173",
            "tenantName": "marg.collier",
            "enabled": true,
            "roles": [
              {
                "id": 997,
                "code": "99507",
                "name": "marg.collier",
                "tenantName": "marg.collier",
                "enabled": true,
                "users": [
                  {
                    "$ref": "..."
                  }
                ],
                "permIds": [
                  557
                ],
                "permissions": [
                  {
                    "id": 530,
                    "code": "99507",
                    "name": "marg.collier",
                    "permType": 290,
                    "parentId": 319,
                    "parentName": "marg.collier",
                    "path": "5fbjg6",
                    "permLevel": 611,
                    "sortNo": 958,
                    "pattern": "zqs1gb",
                    "httpMethod": "yy64vt",
                    "isHidden": true,
                    "icon": "k9ek7k",
                    "terminalCode": "99507",
                    "menuDepth": 127,
                    "isQuick": true
                  }
                ],
                "noPermission": true
              }
            ],
            "permissions": [
              {
                "id": 436,
                "code": "99507",
                "name": "marg.collier",
                "permType": 853,
                "parentId": 14,
                "parentName": "marg.collier",
                "path": "oi8aw1",
                "permLevel": 541,
                "sortNo": 735,
                "pattern": "to4x5b",
                "httpMethod": "6dt92q",
                "isHidden": true,
                "icon": "3k1sak",
                "terminalCode": "99507",
                "menuDepth": 219,
                "isQuick": true
              }
            ]
          }
        ],
        "permIds": [
          911
        ],
        "permissions": [
          {
            "id": 975,
            "code": "99507",
            "name": "marg.collier",
            "permType": 110,
            "parentId": 338,
            "parentName": "marg.collier",
            "path": "gvw4ob",
            "permLevel": 433,
            "sortNo": 149,
            "pattern": "2tpnhh",
            "httpMethod": "i7dwjc",
            "isHidden": true,
            "icon": "ujtec3",
            "terminalCode": "99507",
            "menuDepth": 58,
            "isQuick": true
          }
        ],
        "noPermission": true
      }
    ],
    "permissions": {
      "mapKey": {}
    },
    "sysDataRoleVOS": [
      {
        "id": 617,
        "code": "99507",
        "name": "marg.collier",
        "enabled": true,
        "advancedEnable": true,
        "businessEnable": true,
        "sysDataAuthVO": {
          "isAll": true,
          "buAuthEnable": true,
          "buDataAuthScope": "ALL",
          "empAuthEnable": true,
          "userDataAuthScope": "ALL",
          "ouAuthEnable": true,
          "dataRoleId": 270,
          "isBasic": true,
          "permissionId": 505,
          "permissionCode": "99507",
          "buIdSet": [
            423
          ],
          "userIdSet": [
            240
          ],
          "ouIdSet": [
            748
          ]
        },
        "stringSysDataPermissionVOMap": {
          "mapKey": {
            "isAll": true,
            "buAuthEnable": true,
            "buDataAuthScope": "ALL",
            "empAuthEnable": true,
            "userDataAuthScope": "ALL",
            "ouAuthEnable": true,
            "dataRoleId": 353,
            "isBasic": true,
            "permissionId": 934,
            "permissionCode": "99507",
            "buIdSet": [
              700
            ],
            "userIdSet": [
              181
            ],
            "ouIdSet": [
              987
            ]
          }
        },
        "sysBizDataConstraintVO": [
          {
            "metaColumnId": 151,
            "dataRoleCode": "99507",
            "dataRoleName": "marg.collier",
            "domainCode": "99507",
            "domainName": "marg.collier",
            "tableCode": "99507",
            "tableName": "marg.collier",
            "fieldCode": "99507",
            "fieldCaption": "m54695",
            "fieldType": "1qz10l",
            "fieldUdcType": "q4vt7v",
            "udcDomainCode": "99507",
            "udcCode": "99507",
            "defaultValue": "w1xeqc",
            "compareOpCode": "99507",
            "compareOpName": "marg.collier",
            "constraintValues": "lsixhp"
          }
        ]
      }
    ],
    "avatarUrl": "www.williams-bashirian.biz",
    "avatarCode": "99507",
    "terminals": [
      "BACKEND"
    ],
    "sysTenantVO": {
      "id": 868,
      "tenantCode": "99507",
      "tenantName": "marg.collier",
      "sysUserId": 757,
      "type": "COMMON",
      "isolationStrategy": "DATABASE",
      "dbInitialized": true,
      "tenantDomain": "marquardt.org",
      "customDomain": "marquardt.org",
      "databaseSourceId": 224,
      "schemaName": "marg.collier",
      "industry": "exshyh",
      "customer": "btfzqn"
    },
    "sysTenantDTOList": [
      {
        "id": 945,
        "tenantCode": "99507",
        "tenantName": "marg.collier",
        "sysUserId": 395,
        "type": "COMMON",
        "isolationStrategy": "DATABASE",
        "dbInitialized": true,
        "tenantDomain": "marquardt.org",
        "customDomain": "marquardt.org",
        "databaseSourceId": 248,
        "schemaName": "marg.collier",
        "industry": "szby0j",
        "customer": "zvwsq8"
      }
    ]
  },
  "time": "2023-02-13 08:31:52"
}

Curl-example:

curl -X GET -H 'Authorization' -i http://127.0.0.1:9010/sys/users/current

3.17.8.

URL: http://127.0.0.1:9010/sys/users/redisUtils

Type: GET

Author: Michael Li

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description:

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

array

响应数据

└─id

int64

└─parentId

int64

父权限ID

└─roleCode

string

后端用

└─code

string

编号，前端用

└─name

string

名称，前端用

└─permType

int32

后端用

└─pattern

string

后端用

└─httpMethod

string

后端用

└─isHidden

boolean

No comments found.

└─isQuick

boolean

菜单是否隐藏

└─sortNo

int32

No comments found.

└─terminalCode

string

No comments found.

time

string

响应时间

Response-example:

{
  "code": 131,
  "msg": "ue9kcv",
  "errorMsg": "xjqrcl",
  "success": true,
  "errorNo": "pwcrdh",
  "data": [
    {
      "id": 480,
      "parentId": 574,
      "roleCode": "99507",
      "code": "99507",
      "name": "marg.collier",
      "permType": 484,
      "pattern": "9aghmk",
      "httpMethod": "he10wr",
      "isHidden": true,
      "isQuick": true,
      "sortNo": 45,
      "terminalCode": "99507"
    }
  ],
  "time": "2023-02-13 08:31:52"
}

Curl-example:

curl -X GET -H 'Authorization' -i http://127.0.0.1:9010/sys/users/redisUtils

3.17.9.

URL: http://127.0.0.1:9010/sys/users/current/menus/{terminalCode}

Type: GET

Author: Michael Li

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description:

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Path-parameters:

Parameter

Value

Type

Required

Description

terminalCode

string

true

No comments found.

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

array

响应数据

└─id

int64

权限ID

└─parentId

int64

No comments found.

└─code

string

权限编号

└─name

string

权限名称

└─sortNo

int32

排序

└─pattern

string

路由

└─isHidden

boolean

菜单是否隐藏

└─isQuick

boolean

菜单是否隐藏

└─icon

string

图标

└─terminalCode

string

No comments found.

└─childNodes

array

当前子节点数据

time

string

响应时间

Response-example:

{
  "code": 378,
  "msg": "f2ng4k",
  "errorMsg": "jpng11",
  "success": true,
  "errorNo": "55aelo",
  "data": [
    {
      "id": 785,
      "parentId": 94,
      "code": "99507",
      "name": "marg.collier",
      "sortNo": 649,
      "pattern": "dba8kc",
      "isHidden": true,
      "isQuick": true,
      "icon": "b7m7vb",
      "terminalCode": "99507",
      "childNodes": [
        {
          "$ref": ".."
        }
      ]
    }
  ],
  "time": "2023-02-13 08:31:52"
}

Curl-example:

curl -X GET -H 'Authorization' -i http://127.0.0.1:9010/sys/users/current/menus/99507

3.17.10.

URL: http://127.0.0.1:9010/sys/users/current/menutrees/{terminalCode}

Type: GET

Author: Michael Li

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description:

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Path-parameters:

Parameter

Value

Type

Required

Description

terminalCode

string

true

No comments found.

Query-parameters:

Parameter

Value

Type

Required

Description

nodeId

int64

false

No comments found.

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

array

响应数据

└─id

int64

权限ID

└─parentId

int64

No comments found.

└─code

string

权限编号

└─name

string

权限名称

└─sortNo

int32

排序

└─pattern

string

路由

└─isHidden

boolean

菜单是否隐藏

└─isQuick

boolean

菜单是否隐藏

└─icon

string

图标

└─terminalCode

string

No comments found.

└─childNodes

array

当前子节点数据

time

string

响应时间

Response-example:

{
  "code": 666,
  "msg": "po7uih",
  "errorMsg": "aoyts8",
  "success": true,
  "errorNo": "efh7o6",
  "data": [
    {
      "id": 255,
      "parentId": 961,
      "code": "99507",
      "name": "marg.collier",
      "sortNo": 81,
      "pattern": "1gruoc",
      "isHidden": true,
      "isQuick": true,
      "icon": "xqeo9b",
      "terminalCode": "99507",
      "childNodes": [
        {
          "$ref": ".."
        }
      ]
    }
  ],
  "time": "2023-02-13 08:31:52"
}

Curl-example:

curl -X GET -H 'Authorization' -i http://127.0.0.1:9010/sys/users/current/menutrees/99507?nodeId=0 --data '&0'

3.17.11.

URL: http://127.0.0.1:9010/sys/users/current/menus/{menuId}/{terminalCode}

Type: GET

Author: Michael Li

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description:

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Path-parameters:

Parameter

Value

Type

Required

Description

menuId

int64

true

No comments found.

terminalCode

string

true

No comments found.

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

array

响应数据

└─id

int64

权限ID

└─parentId

int64

No comments found.

└─code

string

权限编号

└─name

string

权限名称

└─sortNo

int32

排序

└─pattern

string

路由

└─isHidden

boolean

菜单是否隐藏

└─isQuick

boolean

菜单是否隐藏

└─icon

string

图标

└─terminalCode

string

No comments found.

└─childNodes

array

当前子节点数据

time

string

响应时间

Response-example:

{
  "code": 129,
  "msg": "6ld4f9",
  "errorMsg": "eounku",
  "success": true,
  "errorNo": "7eb047",
  "data": [
    {
      "id": 120,
      "parentId": 499,
      "code": "99507",
      "name": "marg.collier",
      "sortNo": 23,
      "pattern": "od859k",
      "isHidden": true,
      "isQuick": true,
      "icon": "8dr96w",
      "terminalCode": "99507",
      "childNodes": [
        {
          "$ref": ".."
        }
      ]
    }
  ],
  "time": "2023-02-13 08:31:52"
}

Curl-example:

curl -X GET -H 'Authorization' -i http://127.0.0.1:9010/sys/users/current/menus/413/99507

3.17.12.

URL: http://127.0.0.1:9010/sys/users/current/actions

Type: GET

Author: Michael Li

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description:

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

array

响应数据

└─id

int64

权限ID

└─parentId

int64

No comments found.

└─code

string

权限编号

└─name

string

权限名称

└─sortNo

int32

排序

└─pattern

string

路由

└─isHidden

boolean

菜单是否隐藏

└─isQuick

boolean

菜单是否隐藏

└─icon

string

图标

└─terminalCode

string

No comments found.

└─childNodes

array

当前子节点数据

time

string

响应时间

Response-example:

{
  "code": 913,
  "msg": "zh0xtu",
  "errorMsg": "sh1al5",
  "success": true,
  "errorNo": "nldx0v",
  "data": [
    {
      "id": 651,
      "parentId": 126,
      "code": "99507",
      "name": "marg.collier",
      "sortNo": 815,
      "pattern": "n5ijvb",
      "isHidden": true,
      "isQuick": true,
      "icon": "mcra51",
      "terminalCode": "99507",
      "childNodes": [
        {
          "$ref": ".."
        }
      ]
    }
  ],
  "time": "2023-02-13 08:31:52"
}

Curl-example:

curl -X GET -H 'Authorization' -i http://127.0.0.1:9010/sys/users/current/actions

3.17.13.

URL: http://127.0.0.1:9010/sys/users/reset/pwd/{userId}

Type: PUT

Author: Michael Li

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description:

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Path-parameters:

Parameter

Value

Type

Required

Description

userId

int64

true

No comments found.

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

└─any object

object

any object.

time

string

响应时间

Response-example:

{
  "code": 660,
  "msg": "3zbehq",
  "errorMsg": "7hvsrn",
  "success": true,
  "errorNo": "og0zhi",
  "data": {},
  "time": "2023-02-13 08:31:52"
}

Curl-example:

curl -X PUT -H 'Authorization' -i http://127.0.0.1:9010/sys/users/reset/pwd/617

3.17.14.

URL: http://127.0.0.1:9010/sys/users/{id}

Type: PUT

Author: Michael Li

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description:

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Path-parameters:

Parameter

Value

Type

Required

Description

int64

true

No comments found.

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

boolean

响应数据

time

string

响应时间

Response-example:

{
  "code": 508,
  "msg": "w33bky",
  "errorMsg": "4kw24k",
  "success": true,
  "errorNo": "on6e64",
  "data": true,
  "time": "2023-02-13 08:31:52"
}

Curl-example:

curl -X PUT -H 'Authorization' -i http://127.0.0.1:9010/sys/users/426

3.17.15.

URL: http://127.0.0.1:9010/sys/users/switch/batch

Type: PUT

Author: Michael Li

Content-Type: application/json

Description:

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Body-parameters:

Parameter

Type

Required

Description

userIds

array

false

No comments found.

enable

boolean

false

No comments found.

Request-body:

{
  "userIds": [
    275
  ],
  "enable": true
}

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

└─any object

object

any object.

time

string

响应时间

Response-example:

{
  "code": 916,
  "msg": "zzv0gy",
  "errorMsg": "z5klk1",
  "success": true,
  "errorNo": "qeu7fk",
  "data": {},
  "time": "2023-02-13 08:31:52"
}

Curl-example:

curl -X PUT -H 'Content-Type: application/json' -H 'Authorization' -i http://127.0.0.1:9010/sys/users/switch/batch --data '{
  "userIds": [
    275
  ],
  "enable": true
}'

3.17.16.

URL: http://127.0.0.1:9010/sys/users/changep

Type: PUT

Author: Michael Li

Content-Type: application/json

Description:

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Body-parameters:

Parameter

Type

Required

Description

userId

int64

false

No comments found.

currentPassword

string

false

No comments found.

newPassword

string

false

No comments found.

Request-body:

{
  "userId": 287,
  "currentPassword": "2j9vsz",
  "newPassword": "nycqik"
}

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

└─any object

object

any object.

time

string

响应时间

Response-example:

{
  "code": 78,
  "msg": "ocuref",
  "errorMsg": "z3j4iz",
  "success": true,
  "errorNo": "23kjtz",
  "data": {},
  "time": "2023-02-13 08:31:52"
}

Curl-example:

curl -X PUT -H 'Content-Type: application/json' -H 'Authorization' -i http://127.0.0.1:9010/sys/users/changep --data '{
  "userId": 287,
  "currentPassword": "2j9vsz",
  "newPassword": "nycqik"
}'

3.17.17.

URL: http://127.0.0.1:9010/sys/users/changeNewP

Type: PUT

Author: Michael Li

Content-Type: application/json

Description:

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Body-parameters:

Parameter

Type

Required

Description

userId

int64

false

No comments found.

currentPassword

string

false

No comments found.

newPassword

string

false

No comments found.

Request-body:

{
  "userId": 811,
  "currentPassword": "oe5w8k",
  "newPassword": "hi8fwa"
}

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

└─any object

object

any object.

time

string

响应时间

Response-example:

{
  "code": 400,
  "msg": "pm9oim",
  "errorMsg": "eameee",
  "success": true,
  "errorNo": "2sds3s",
  "data": {},
  "time": "2023-02-13 08:31:52"
}

Curl-example:

curl -X PUT -H 'Content-Type: application/json' -H 'Authorization' -i http://127.0.0.1:9010/sys/users/changeNewP --data '{
  "userId": 811,
  "currentPassword": "oe5w8k",
  "newPassword": "hi8fwa"
}'

3.17.18.

URL: http://127.0.0.1:9010/sys/users/changePhone

Type: PUT

Author: Michael Li

Content-Type: application/json

Description:

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Body-parameters:

Parameter

Type

Required

Description

userId

int64

false

No comments found.

account

string

true

No comments found.

accountType

string

false

No comments found.

Request-body:

{
  "userId": 568,
  "account": "sep6ty",
  "accountType": "i58bwe"
}

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

└─any object

object

any object.

time

string

响应时间

Response-example:

{
  "code": 513,
  "msg": "xdxnxw",
  "errorMsg": "xbbeew",
  "success": true,
  "errorNo": "28dj6r",
  "data": {},
  "time": "2023-02-13 08:31:52"
}

Curl-example:

curl -X PUT -H 'Content-Type: application/json' -H 'Authorization' -i http://127.0.0.1:9010/sys/users/changePhone --data '{
  "userId": 568,
  "account": "sep6ty",
  "accountType": "i58bwe"
}'

3.17.19.

URL: http://127.0.0.1:9010/sys/users/decode

Type: GET

Author: Michael Li

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description:

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Query-parameters:

Parameter

Value

Type

Required

Description

rawPassworod

string

true

No comments found.

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

time

string

响应时间

Response-example:

{
  "code": 525,
  "msg": "2db81f",
  "errorMsg": "arf4yt",
  "success": true,
  "errorNo": "c0lubp",
  "data": {},
  "time": "2023-02-13 08:31:52"
}

Curl-example:

curl -X GET -H 'Authorization' -i http://127.0.0.1:9010/sys/users/decode?rawPassworod=jm14wd --data '&jm14wd'

3.17.20.

URL: http://127.0.0.1:9010/sys/users/updateReole

Type: PUT

Author: Michael Li

Content-Type: application/json

Description:

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Body-parameters:

Parameter

Type

Required

Description

int64

false

用户ID

lastName

string

false

用户姓氏

userName

string

false

用户姓氏

firstName

string

false

用户名称

mobile

string

false

用户手机号码

string

false

用户邮箱地址

tenantId

string

false

No comments found.

tenantName

string

false

No comments found.

enabled

boolean

false

是否启动

ouId

int64

false

用户所属公司ID

ouCode

string

false

用户所属公司编号

ouName

string

false

用户所属公司名称

buId

int64

false

用户所属组织ID

roleIds

array

false

功能角色ID列表

dataRoleIds

array

false

数据角色ID列表

flowRoleIds

array

false

流程角色ID列表

terminals

array

false

用户终端
可登录的端
BACKEND
APP
APPLET

roleName

string

false

No comments found.

password

string

false

No comments found.

Request-body:

{
  "id": 969,
  "lastName": "marg.collier",
  "userName": "marg.collier",
  "firstName": "marg.collier",
  "mobile": "(734) 208-3091",
  "email": "celinda.goldner@gmail.com",
  "tenantId": "173",
  "tenantName": "marg.collier",
  "enabled": true,
  "ouId": 942,
  "ouCode": "99507",
  "ouName": "marg.collier",
  "buId": 183,
  "roleIds": [
    984
  ],
  "dataRoleIds": [
    821
  ],
  "flowRoleIds": [
    387
  ],
  "terminals": [
    "BACKEND"
  ],
  "roleName": "marg.collier",
  "password": "dxa22t"
}

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

boolean

响应数据

time

string

响应时间

Response-example:

{
  "code": 686,
  "msg": "c4z04g",
  "errorMsg": "i5x73v",
  "success": true,
  "errorNo": "pv453g",
  "data": true,
  "time": "2023-02-13 08:31:52"
}

Curl-example:

curl -X PUT -H 'Content-Type: application/json' -H 'Authorization' -i http://127.0.0.1:9010/sys/users/updateReole --data '{
  "id": 969,
  "lastName": "marg.collier",
  "userName": "marg.collier",
  "firstName": "marg.collier",
  "mobile": "(734) 208-3091",
  "email": "celinda.goldner@gmail.com",
  "tenantId": "173",
  "tenantName": "marg.collier",
  "enabled": true,
  "ouId": 942,
  "ouCode": "99507",
  "ouName": "marg.collier",
  "buId": 183,
  "roleIds": [
    984
  ],
  "dataRoleIds": [
    821
  ],
  "flowRoleIds": [
    387
  ],
  "terminals": [
    "BACKEND"
  ],
  "roleName": "marg.collier",
  "password": "dxa22t"
}'

3.17.21.

URL: http://127.0.0.1:9010/sys/users/testUserName/{id}/{userName}

Type: PATCH

Author: Michael Li

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description:

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Path-parameters:

Parameter

Value

Type

Required

Description

int64

true

No comments found.

userName

string

true

No comments found.

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

└─any object

object

any object.

time

string

响应时间

Response-example:

{
  "code": 15,
  "msg": "bwy2id",
  "errorMsg": "0jpnxf",
  "success": true,
  "errorNo": "4k2jqb",
  "data": {},
  "time": "2023-02-13 08:31:52"
}

Curl-example:

curl -X PATCH -H 'Authorization' -i http://127.0.0.1:9010/sys/users/testUserName/495/marg.collier

3.17.22.

URL: http://127.0.0.1:9010/sys/users/testMobile/{id}/mobile

Type: PATCH

Author: Michael Li

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description:

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Path-parameters:

Parameter

Value

Type

Required

Description

int64

true

No comments found.

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

└─any object

object

any object.

time

string

响应时间

Response-example:

{
  "code": 424,
  "msg": "vcx3gz",
  "errorMsg": "z86gh9",
  "success": true,
  "errorNo": "t4e0iy",
  "data": {},
  "time": "2023-02-13 08:31:52"
}

Curl-example:

curl -X PATCH -H 'Authorization' -i http://127.0.0.1:9010/sys/users/testMobile/715/mobile

3.17.23.

URL: http://127.0.0.1:9010/sys/users/updateusernameandphone

Type: PUT

Author: Michael Li

Content-Type: application/json

Description:

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Body-parameters:

Parameter

Type

Required

Description

int64

false

用户ID

lastName

string

false

用户姓氏

userName

string

false

用户姓氏

firstName

string

false

用户名称

mobile

string

false

用户手机号码

string

false

用户邮箱地址

tenantId

string

false

No comments found.

tenantName

string

false

No comments found.

enabled

boolean

false

是否启动

ouId

int64

false

用户所属公司ID

ouCode

string

false

用户所属公司编号

ouName

string

false

用户所属公司名称

buId

int64

false

用户所属组织ID

roleIds

array

false

功能角色ID列表

dataRoleIds

array

false

数据角色ID列表

flowRoleIds

array

false

流程角色ID列表

terminals

array

false

用户终端
可登录的端
BACKEND
APP
APPLET

roleName

string

false

No comments found.

password

string

false

No comments found.

Request-body:

{
  "id": 776,
  "lastName": "marg.collier",
  "userName": "marg.collier",
  "firstName": "marg.collier",
  "mobile": "(734) 208-3091",
  "email": "celinda.goldner@gmail.com",
  "tenantId": "173",
  "tenantName": "marg.collier",
  "enabled": true,
  "ouId": 513,
  "ouCode": "99507",
  "ouName": "marg.collier",
  "buId": 931,
  "roleIds": [
    250
  ],
  "dataRoleIds": [
    158
  ],
  "flowRoleIds": [
    244
  ],
  "terminals": [
    "BACKEND"
  ],
  "roleName": "marg.collier",
  "password": "lbv95a"
}

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

boolean

响应数据

time

string

响应时间

Response-example:

{
  "code": 901,
  "msg": "nlsblk",
  "errorMsg": "j8uj4n",
  "success": true,
  "errorNo": "g2obwi",
  "data": true,
  "time": "2023-02-13 08:31:52"
}

Curl-example:

curl -X PUT -H 'Content-Type: application/json' -H 'Authorization' -i http://127.0.0.1:9010/sys/users/updateusernameandphone --data '{
  "id": 776,
  "lastName": "marg.collier",
  "userName": "marg.collier",
  "firstName": "marg.collier",
  "mobile": "(734) 208-3091",
  "email": "celinda.goldner@gmail.com",
  "tenantId": "173",
  "tenantName": "marg.collier",
  "enabled": true,
  "ouId": 513,
  "ouCode": "99507",
  "ouName": "marg.collier",
  "buId": 931,
  "roleIds": [
    250
  ],
  "dataRoleIds": [
    158
  ],
  "flowRoleIds": [
    244
  ],
  "terminals": [
    "BACKEND"
  ],
  "roleName": "marg.collier",
  "password": "lbv95a"
}'

3.18. .

3.18.1.

URL: http://127.0.0.1:9010/sys/user/self/avatar

Type: PUT

Author: Kaiser（wang shao）

Content-Type: application/json

Description:

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Body-parameters:

Parameter

Type

Required

Description

avatarUrl

string

false

No comments found.

avatarCode

string

false

No comments found.

Request-body:

{
  "avatarUrl": "www.williams-bashirian.biz",
  "avatarCode": "99507"
}

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

int64

响应数据

time

string

响应时间

Response-example:

{
  "code": 516,
  "msg": "9jm70t",
  "errorMsg": "5caway",
  "success": true,
  "errorNo": "25ub1f",
  "data": 388,
  "time": "2023-02-13 08:31:52"
}

Curl-example:

curl -X PUT -H 'Content-Type: application/json' -H 'Authorization' -i http://127.0.0.1:9010/sys/user/self/avatar --data '{
  "avatarUrl": "www.williams-bashirian.biz",
  "avatarCode": "99507"
}'

3.18.2.

URL: http://127.0.0.1:9010/sys/user/self/updatePwd/verifyCode

Type: POST

Author: Kaiser（wang shao）

Content-Type: application/json

Description:

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Body-parameters:

Parameter

Type

Required

Description

account

string

true

No comments found.

accountType

string

false

No comments found.

period

int64

false

No comments found.

Request-body:

{
  "account": "j519wo",
  "accountType": "dl71fj",
  "period": 872
}

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

boolean

响应数据

time

string

响应时间

Response-example:

{
  "code": 802,
  "msg": "jsafz9",
  "errorMsg": "k8sx8z",
  "success": true,
  "errorNo": "gdik0c",
  "data": true,
  "time": "2023-02-13 08:31:52"
}

Curl-example:

curl -X POST -H 'Content-Type: application/json' -H 'Authorization' -i http://127.0.0.1:9010/sys/user/self/updatePwd/verifyCode --data '{
  "account": "j519wo",
  "accountType": "dl71fj",
  "period": 872
}'

3.18.3.

URL: http://127.0.0.1:9010/sys/user/self/updatePwd/verifyCode

Type: PUT

Author: Kaiser（wang shao）

Content-Type: application/json

Description:

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Body-parameters:

Parameter

Type

Required

Description

account

string

true

No comments found.

accountType

string

false

No comments found.

verifyCode

string

true

No comments found.

password

string

true

No comments found.

Request-body:

{
  "account": "zhuubg",
  "accountType": "s1el6f",
  "verifyCode": "99507",
  "password": "h79jkd"
}

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

int64

响应数据

time

string

响应时间

Response-example:

{
  "code": 932,
  "msg": "f3tsun",
  "errorMsg": "nelrjw",
  "success": true,
  "errorNo": "khgmuu",
  "data": 729,
  "time": "2023-02-13 08:31:52"
}

Curl-example:

curl -X PUT -H 'Content-Type: application/json' -H 'Authorization' -i http://127.0.0.1:9010/sys/user/self/updatePwd/verifyCode --data '{
  "account": "zhuubg",
  "accountType": "s1el6f",
  "verifyCode": "99507",
  "password": "h79jkd"
}'

3.18.4.

URL: http://127.0.0.1:9010/sys/user/self/updateAccount/verifyCode

Type: POST

Author: Kaiser（wang shao）

Content-Type: application/json

Description:

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Body-parameters:

Parameter

Type

Required

Description

account

string

true

No comments found.

accountType

string

false

No comments found.

period

int64

false

No comments found.

Request-body:

{
  "account": "40w4vw",
  "accountType": "w9zb0o",
  "period": 623
}

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

boolean

响应数据

time

string

响应时间

Response-example:

{
  "code": 42,
  "msg": "7rpsfu",
  "errorMsg": "9dpb89",
  "success": true,
  "errorNo": "pop2b4",
  "data": true,
  "time": "2023-02-13 08:31:52"
}

Curl-example:

curl -X POST -H 'Content-Type: application/json' -H 'Authorization' -i http://127.0.0.1:9010/sys/user/self/updateAccount/verifyCode --data '{
  "account": "40w4vw",
  "accountType": "w9zb0o",
  "period": 623
}'

3.18.5.

URL: http://127.0.0.1:9010/sys/user/self/updateAccount/verifyOldAccount

Type: POST

Author: Kaiser（wang shao）

Content-Type: application/json

Description:

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Body-parameters:

Parameter

Type

Required

Description

account

string

true

No comments found.

accountType

string

false

No comments found.

verifyCode

string

true

No comments found.

Request-body:

{
  "account": "vl63i6",
  "accountType": "14bln7",
  "verifyCode": "99507"
}

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

string

响应数据

time

string

响应时间

Response-example:

{
  "code": 422,
  "msg": "3ztilm",
  "errorMsg": "4wll4q",
  "success": true,
  "errorNo": "kmebf9",
  "data": "3l7yak",
  "time": "2023-02-13 08:31:52"
}

Curl-example:

curl -X POST -H 'Content-Type: application/json' -H 'Authorization' -i http://127.0.0.1:9010/sys/user/self/updateAccount/verifyOldAccount --data '{
  "account": "vl63i6",
  "accountType": "14bln7",
  "verifyCode": "99507"
}'

3.18.6.

URL: http://127.0.0.1:9010/sys/user/self/updateAccount/verifyCode

Type: PUT

Author: Kaiser（wang shao）

Content-Type: application/json

Description:

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Body-parameters:

Parameter

Type

Required

Description

account

string

true

No comments found.

accountType

string

false

No comments found.

verifyCode

string

true

No comments found.

verifyId

string

true

No comments found.

Request-body:

{
  "account": "35i6it",
  "accountType": "s6fxvw",
  "verifyCode": "99507",
  "verifyId": "173"
}

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

int64

响应数据

time

string

响应时间

Response-example:

{
  "code": 605,
  "msg": "2293q6",
  "errorMsg": "w1mi9x",
  "success": true,
  "errorNo": "9j6e8i",
  "data": 867,
  "time": "2023-02-13 08:31:52"
}

Curl-example:

curl -X PUT -H 'Content-Type: application/json' -H 'Authorization' -i http://127.0.0.1:9010/sys/user/self/updateAccount/verifyCode --data '{
  "account": "35i6it",
  "accountType": "s6fxvw",
  "verifyCode": "99507",
  "verifyId": "173"
}'

3.19. 功能说明

3.19.1. 通过主键查询单条数据

URL: http://127.0.0.1:9010/sys/sysQuickEntry/findIdOne/{id}

Type: GET

Author: roman.zhang

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 通过主键查询单条数据

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Path-parameters:

Parameter

Value

Type

Required

Description

int64

true

主键

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

└─id

int64

记录唯一ID

└─quickData

string

快捷入口数据：前端传递，后端直接返回

└─tenantId

int64

租户ID

└─remark

string

备注

└─createUserId

int64

记录创建者ID

└─creator

string

记录创建者

└─createTime

string

记录创建时间

└─modifyUserId

int64

记录最后更新者ID

└─updater

string

记录最后更新者

└─modifyTime

string

记录最后更新时间

└─deleteFlag

int32

逻辑删除，0：未删除，1：已删除

└─auditDataVersion

int32

锁版本

└─secBuId

int64

sec_bu_id

└─secUserId

int64

sec_user_id

└─secOuId

int64

sec_ou_id

time

string

响应时间

Response-example:

{
  "code": 154,
  "msg": "6twmpo",
  "errorMsg": "ttxsc4",
  "success": true,
  "errorNo": "rglli3",
  "data": {
    "id": 821,
    "quickData": "lkhxp1",
    "tenantId": 7,
    "remark": "dby2ke",
    "createUserId": 223,
    "creator": "e7h9op",
    "createTime": "2023-02-13 08:31:50",
    "modifyUserId": 426,
    "updater": "o6hwhr",
    "modifyTime": "2023-02-13 08:31:50",
    "deleteFlag": 9,
    "auditDataVersion": 88,
    "secBuId": 695,
    "secUserId": 925,
    "secOuId": 226
  },
  "time": "2023-02-13 08:31:52"
}

Curl-example:

curl -X GET -H 'Authorization' -i http://127.0.0.1:9010/sys/sysQuickEntry/findIdOne/564

3.19.2. 根据关键字段查询数据

URL: http://127.0.0.1:9010/sys/sysQuickEntry/findCodeOne/{key}

Type: GET

Author: roman.zhang

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据关键字段查询数据

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Path-parameters:

Parameter

Value

Type

Required

Description

key

string

true

参数

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

└─id

int64

记录唯一ID

└─quickData

string

快捷入口数据：前端传递，后端直接返回

└─tenantId

int64

租户ID

└─remark

string

备注

└─createUserId

int64

记录创建者ID

└─creator

string

记录创建者

└─createTime

string

记录创建时间

└─modifyUserId

int64

记录最后更新者ID

└─updater

string

记录最后更新者

└─modifyTime

string

记录最后更新时间

└─deleteFlag

int32

逻辑删除，0：未删除，1：已删除

└─auditDataVersion

int32

锁版本

└─secBuId

int64

sec_bu_id

└─secUserId

int64

sec_user_id

└─secOuId

int64

sec_ou_id

time

string

响应时间

Response-example:

{
  "code": 235,
  "msg": "og18vm",
  "errorMsg": "ybyok2",
  "success": true,
  "errorNo": "1h2v44",
  "data": {
    "id": 252,
    "quickData": "a04qs1",
    "tenantId": 769,
    "remark": "s85a91",
    "createUserId": 320,
    "creator": "ii5adr",
    "createTime": "2023-02-13 08:31:50",
    "modifyUserId": 14,
    "updater": "0kdmex",
    "modifyTime": "2023-02-13 08:31:50",
    "deleteFlag": 9,
    "auditDataVersion": 926,
    "secBuId": 476,
    "secUserId": 652,
    "secOuId": 860
  },
  "time": "2023-02-13 08:31:52"
}

Curl-example:

curl -X GET -H 'Authorization' -i http://127.0.0.1:9010/sys/sysQuickEntry/findCodeOne/vw5oq1

3.19.3. 根据关键字段查询数据

URL: http://127.0.0.1:9010/sys/sysQuickEntry/findDataCurrent

Type: GET

Author: roman.zhang

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据关键字段查询数据

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

└─id

int64

记录唯一ID

└─quickData

string

快捷入口数据：前端传递，后端直接返回

└─tenantId

int64

租户ID

└─remark

string

备注

└─createUserId

int64

记录创建者ID

└─creator

string

记录创建者

└─createTime

string

记录创建时间

└─modifyUserId

int64

记录最后更新者ID

└─updater

string

记录最后更新者

└─modifyTime

string

记录最后更新时间

└─deleteFlag

int32

逻辑删除，0：未删除，1：已删除

└─auditDataVersion

int32

锁版本

└─secBuId

int64

sec_bu_id

└─secUserId

int64

sec_user_id

└─secOuId

int64

sec_ou_id

time

string

响应时间

Response-example:

{
  "code": 86,
  "msg": "ymdff4",
  "errorMsg": "acflnj",
  "success": true,
  "errorNo": "uh97p0",
  "data": {
    "id": 571,
    "quickData": "fy0dr8",
    "tenantId": 96,
    "remark": "ifz818",
    "createUserId": 502,
    "creator": "0cbxzo",
    "createTime": "2023-02-13 08:31:50",
    "modifyUserId": 818,
    "updater": "4pyrd8",
    "modifyTime": "2023-02-13 08:31:50",
    "deleteFlag": 9,
    "auditDataVersion": 237,
    "secBuId": 961,
    "secUserId": 991,
    "secOuId": 178
  },
  "time": "2023-02-13 08:31:52"
}

Curl-example:

curl -X GET -H 'Authorization' -i http://127.0.0.1:9010/sys/sysQuickEntry/findDataCurrent

3.19.4. 分页查询

URL: http://127.0.0.1:9010/sys/sysQuickEntry/search

Type: POST

Author: roman.zhang

Content-Type: application/json

Description: 分页查询

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Body-parameters:

Parameter

Type

Required

Description

current

int32

false

页码

size

int32

false

页大小

keyword

string

false

搜索关键字

orders

array

false

排序

└─column

string

false

属性名称

└─asc

boolean

false

是否升序

int64

false

记录唯一ID

quickData

string

false

快捷入口数据：前端传递，后端直接返回

tenantId

int64

false

租户ID

remark

string

false

备注

createUserId

int64

false

记录创建者ID

creator

string

false

记录创建者

createTime

string

false

记录创建时间

modifyUserId

int64

false

记录最后更新者ID

updater

string

false

记录最后更新者

modifyTime

string

false

记录最后更新时间

deleteFlag

int32

false

逻辑删除，0：未删除，1：已删除

auditDataVersion

int32

false

锁版本

secBuId

int64

false

sec_bu_id

secUserId

int64

false

sec_user_id

secOuId

int64

false

sec_ou_id

Request-body:

{
  "current": 14,
  "size": 10,
  "keyword": "zbtzqn",
  "orders": [
    {
      "column": "y8gj82",
      "asc": true
    }
  ],
  "id": 470,
  "quickData": "fc5ylq",
  "tenantId": 535,
  "remark": "0hpfws",
  "createUserId": 833,
  "creator": "ncvbsz",
  "createTime": "2023-02-13 08:31:50",
  "modifyUserId": 406,
  "updater": "o90k72",
  "modifyTime": "2023-02-13 08:31:50",
  "deleteFlag": 9,
  "auditDataVersion": 927,
  "secBuId": 30,
  "secUserId": 158,
  "secOuId": 548
}

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

└─total

int64

总记录数

└─records

array

数据列表

└─id

int64

记录唯一ID

└─quickData

string

快捷入口数据：前端传递，后端直接返回

└─tenantId

int64

租户ID

└─remark

string

备注

└─createUserId

int64

记录创建者ID

└─creator

string

记录创建者

└─createTime

string

记录创建时间

└─modifyUserId

int64

记录最后更新者ID

└─updater

string

记录最后更新者

└─modifyTime

string

记录最后更新时间

└─deleteFlag

int32

逻辑删除，0：未删除，1：已删除

└─auditDataVersion

int32

锁版本

└─secBuId

int64

sec_bu_id

└─secUserId

int64

sec_user_id

└─secOuId

int64

sec_ou_id

time

string

响应时间

Response-example:

{
  "code": 693,
  "msg": "2yswwx",
  "errorMsg": "pygusu",
  "success": true,
  "errorNo": "jy15g7",
  "data": {
    "total": 134,
    "records": [
      {
        "id": 371,
        "quickData": "mwbr20",
        "tenantId": 505,
        "remark": "eyz4ia",
        "createUserId": 955,
        "creator": "d6akuq",
        "createTime": "2023-02-13 08:31:50",
        "modifyUserId": 56,
        "updater": "985umy",
        "modifyTime": "2023-02-13 08:31:50",
        "deleteFlag": 9,
        "auditDataVersion": 431,
        "secBuId": 811,
        "secUserId": 57,
        "secOuId": 105
      }
    ]
  },
  "time": "2023-02-13 08:31:52"
}

Curl-example:

curl -X POST -H 'Content-Type: application/json' -H 'Authorization' -i http://127.0.0.1:9010/sys/sysQuickEntry/search --data '{
  "current": 14,
  "size": 10,
  "keyword": "zbtzqn",
  "orders": [
    {
      "column": "y8gj82",
      "asc": true
    }
  ],
  "id": 470,
  "quickData": "fc5ylq",
  "tenantId": 535,
  "remark": "0hpfws",
  "createUserId": 833,
  "creator": "ncvbsz",
  "createTime": "2023-02-13 08:31:50",
  "modifyUserId": 406,
  "updater": "o90k72",
  "modifyTime": "2023-02-13 08:31:50",
  "deleteFlag": 9,
  "auditDataVersion": 927,
  "secBuId": 30,
  "secUserId": 158,
  "secOuId": 548
}'

3.19.5. 新增数据

URL: http://127.0.0.1:9010/sys/sysQuickEntry/createOne

Type: POST

Author: roman.zhang

Content-Type: application/json

Description: 新增数据

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Body-parameters:

Parameter

Type

Required

Description

int64

false

记录唯一ID

quickData

string

false

快捷入口数据：前端传递，后端直接返回

tenantId

int64

false

租户ID

remark

string

false

备注

createUserId

int64

false

记录创建者ID

creator

string

false

记录创建者

createTime

string

false

记录创建时间

modifyUserId

int64

false

记录最后更新者ID

updater

string

false

记录最后更新者

modifyTime

string

false

记录最后更新时间

deleteFlag

int32

false

逻辑删除，0：未删除，1：已删除

auditDataVersion

int32

false

锁版本

secBuId

int64

false

sec_bu_id

secUserId

int64

false

sec_user_id

secOuId

int64

false

sec_ou_id

Request-body:

{
  "id": 313,
  "quickData": "kh14xo",
  "tenantId": 741,
  "remark": "zfgrdf",
  "createUserId": 554,
  "creator": "w9bde6",
  "createTime": "2023-02-13 08:31:50",
  "modifyUserId": 548,
  "updater": "juqp8n",
  "modifyTime": "2023-02-13 08:31:50",
  "deleteFlag": 9,
  "auditDataVersion": 641,
  "secBuId": 869,
  "secUserId": 832,
  "secOuId": 244
}

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

└─any object

object

any object.

time

string

响应时间

Response-example:

{
  "code": 920,
  "msg": "hcwetl",
  "errorMsg": "6nst6h",
  "success": true,
  "errorNo": "cwtpvx",
  "data": {},
  "time": "2023-02-13 08:31:52"
}

Curl-example:

curl -X POST -H 'Content-Type: application/json' -H 'Authorization' -i http://127.0.0.1:9010/sys/sysQuickEntry/createOne --data '{
  "id": 313,
  "quickData": "kh14xo",
  "tenantId": 741,
  "remark": "zfgrdf",
  "createUserId": 554,
  "creator": "w9bde6",
  "createTime": "2023-02-13 08:31:50",
  "modifyUserId": 548,
  "updater": "juqp8n",
  "modifyTime": "2023-02-13 08:31:50",
  "deleteFlag": 9,
  "auditDataVersion": 641,
  "secBuId": 869,
  "secUserId": 832,
  "secOuId": 244
}'

3.19.6. 批量新增数据

URL: http://127.0.0.1:9010/sys/sysQuickEntry/createBatch

Type: POST

Author: roman.zhang

Content-Type: application/json

Description: 批量新增数据

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Body-parameters:

Parameter

Type

Required

Description

int64

false

记录唯一ID

quickData

string

false

快捷入口数据：前端传递，后端直接返回

tenantId

int64

false

租户ID

remark

string

false

备注

createUserId

int64

false

记录创建者ID

creator

string

false

记录创建者

createTime

string

false

记录创建时间

modifyUserId

int64

false

记录最后更新者ID

updater

string

false

记录最后更新者

modifyTime

string

false

记录最后更新时间

deleteFlag

int32

false

逻辑删除，0：未删除，1：已删除

auditDataVersion

int32

false

锁版本

secBuId

int64

false

sec_bu_id

secUserId

int64

false

sec_user_id

secOuId

int64

false

sec_ou_id

Request-body:

[
  {
    "id": 374,
    "quickData": "o0hrfa",
    "tenantId": 320,
    "remark": "sxcmme",
    "createUserId": 992,
    "creator": "qjmb1w",
    "createTime": "2023-02-13 08:31:50",
    "modifyUserId": 786,
    "updater": "w2sgvo",
    "modifyTime": "2023-02-13 08:31:50",
    "deleteFlag": 9,
    "auditDataVersion": 902,
    "secBuId": 9,
    "secUserId": 220,
    "secOuId": 732
  }
]

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

└─any object

object

any object.

time

string

响应时间

Response-example:

{
  "code": 179,
  "msg": "2gqmgk",
  "errorMsg": "9gcge7",
  "success": true,
  "errorNo": "7dcvfy",
  "data": {},
  "time": "2023-02-13 08:31:52"
}

Curl-example:

curl -X POST -H 'Content-Type: application/json' -H 'Authorization' -i http://127.0.0.1:9010/sys/sysQuickEntry/createBatch --data '[
  {
    "id": 374,
    "quickData": "o0hrfa",
    "tenantId": 320,
    "remark": "sxcmme",
    "createUserId": 992,
    "creator": "qjmb1w",
    "createTime": "2023-02-13 08:31:50",
    "modifyUserId": 786,
    "updater": "w2sgvo",
    "modifyTime": "2023-02-13 08:31:50",
    "deleteFlag": 9,
    "auditDataVersion": 902,
    "secBuId": 9,
    "secUserId": 220,
    "secOuId": 732
  }
]'

3.19.7. 修改数据

URL: http://127.0.0.1:9010/sys/sysQuickEntry/update

Type: PUT

Author: roman.zhang

Content-Type: application/json

Description: 修改数据

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Body-parameters:

Parameter

Type

Required

Description

int64

false

记录唯一ID

quickData

string

false

快捷入口数据：前端传递，后端直接返回

tenantId

int64

false

租户ID

remark

string

false

备注

createUserId

int64

false

记录创建者ID

creator

string

false

记录创建者

createTime

string

false

记录创建时间

modifyUserId

int64

false

记录最后更新者ID

updater

string

false

记录最后更新者

modifyTime

string

false

记录最后更新时间

deleteFlag

int32

false

逻辑删除，0：未删除，1：已删除

auditDataVersion

int32

false

锁版本

secBuId

int64

false

sec_bu_id

secUserId

int64

false

sec_user_id

secOuId

int64

false

sec_ou_id

Request-body:

{
  "id": 858,
  "quickData": "9mldl6",
  "tenantId": 533,
  "remark": "13mnb9",
  "createUserId": 261,
  "creator": "usggua",
  "createTime": "2023-02-13 08:31:50",
  "modifyUserId": 553,
  "updater": "ey44nf",
  "modifyTime": "2023-02-13 08:31:50",
  "deleteFlag": 9,
  "auditDataVersion": 2,
  "secBuId": 207,
  "secUserId": 711,
  "secOuId": 828
}

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

└─any object

object

any object.

time

string

响应时间

Response-example:

{
  "code": 735,
  "msg": "jlgm19",
  "errorMsg": "0urybu",
  "success": true,
  "errorNo": "i6gldh",
  "data": {},
  "time": "2023-02-13 08:31:52"
}

Curl-example:

curl -X PUT -H 'Content-Type: application/json' -H 'Authorization' -i http://127.0.0.1:9010/sys/sysQuickEntry/update --data '{
  "id": 858,
  "quickData": "9mldl6",
  "tenantId": 533,
  "remark": "13mnb9",
  "createUserId": 261,
  "creator": "usggua",
  "createTime": "2023-02-13 08:31:50",
  "modifyUserId": 553,
  "updater": "ey44nf",
  "modifyTime": "2023-02-13 08:31:50",
  "deleteFlag": 9,
  "auditDataVersion": 2,
  "secBuId": 207,
  "secUserId": 711,
  "secOuId": 828
}'

3.19.8. 根据主键删除数据

URL: http://127.0.0.1:9010/sys/sysQuickEntry/deleteOne/{id}

Type: DELETE

Author: roman.zhang

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据主键删除数据

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Path-parameters:

Parameter

Value

Type

Required

Description

int64

true

主键

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

└─any object

object

any object.

time

string

响应时间

Response-example:

{
  "code": 368,
  "msg": "wxkven",
  "errorMsg": "4adz0t",
  "success": true,
  "errorNo": "re0506",
  "data": {},
  "time": "2023-02-13 08:31:52"
}

Curl-example:

curl -X DELETE -H 'Authorization' -i http://127.0.0.1:9010/sys/sysQuickEntry/deleteOne/582

3.19.9. 批量删除

URL: http://127.0.0.1:9010/sys/sysQuickEntry/deleteBatch

Type: DELETE

Author: roman.zhang

Content-Type: application/json

Description: 批量删除

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Body-parameters:

Parameter

Type

Required

Description

ids

array

false

删除数据集合,[array of int64]@since

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

└─any object

object

any object.

time

string

响应时间

Response-example:

{
  "code": 379,
  "msg": "xwl88m",
  "errorMsg": "f0rt6l",
  "success": true,
  "errorNo": "6lyjzk",
  "data": {},
  "time": "2023-02-13 08:31:52"
}

Curl-example:

curl -X DELETE -H 'Content-Type: application/json' -H 'Authorization' -i http://127.0.0.1:9010/sys/sysQuickEntry/deleteBatch --data '[]'

3.19.10. 逻辑删除

URL: http://127.0.0.1:9010/sys/sysQuickEntry/updateDeleteFlag/{id}

Type: PUT

Author: roman.zhang

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 逻辑删除

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Path-parameters:

Parameter

Value

Type

Required

Description

int64

true

更新数据

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

└─any object

object

any object.

time

string

响应时间

Response-example:

{
  "code": 974,
  "msg": "kbgzwh",
  "errorMsg": "5q0etp",
  "success": true,
  "errorNo": "zqa20l",
  "data": {},
  "time": "2023-02-13 08:31:52"
}

Curl-example:

curl -X PUT -H 'Authorization' -i http://127.0.0.1:9010/sys/sysQuickEntry/updateDeleteFlag/642

3.20. .

3.20.1. 获取角色对应的权限资源（缓存）

URL: http://127.0.0.1:9010/sys/test/queryPermission

Type: GET

Author: Kaiser（wang shao）

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 获取角色对应的权限资源（缓存）

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Query-parameters:

Parameter

Value

Type

Required

Description

permType

enum

false

MENU
ACTION

roleId

int64

false

角色ID

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

└─any object

object

any object.

time

string

响应时间

Response-example:

{
  "code": 512,
  "msg": "yjuqap",
  "errorMsg": "q5o73r",
  "success": true,
  "errorNo": "p6gx1s",
  "data": {},
  "time": "2023-02-13 08:31:52"
}

Curl-example:

curl -X GET -H 'Authorization' -i http://127.0.0.1:9010/sys/test/queryPermission?permType=MENU&roleId=388

3.20.2. 获取权限按钮所需角色（缓存）

URL: http://127.0.0.1:9010/sys/test/queryPermissionActions

Type: GET

Author: Kaiser（wang shao）

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 获取权限按钮所需角色（缓存）

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Query-parameters:

Parameter

Value

Type

Required

Description

permissionId

int64

false

No comments found.

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

└─any object

object

any object.

time

string

响应时间

Response-example:

{
  "code": 412,
  "msg": "ty03n9",
  "errorMsg": "gqi3xe",
  "success": true,
  "errorNo": "rvgkay",
  "data": {},
  "time": "2023-02-13 08:31:52"
}

Curl-example:

curl -X GET -H 'Authorization' -i http://127.0.0.1:9010/sys/test/queryPermissionActions?permissionId=916

3.20.3. 清除缓存中的权限

URL: http://127.0.0.1:9010/sys/test/clearPermission

Type: GET

Author: Kaiser（wang shao）

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 清除缓存中的权限

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

└─any object

object

any object.

time

string

响应时间

Response-example:

{
  "code": 149,
  "msg": "n7khmn",
  "errorMsg": "a39bts",
  "success": true,
  "errorNo": "ovcbow",
  "data": {},
  "time": "2023-02-13 08:31:52"
}

Curl-example:

curl -X GET -H 'Authorization' -i http://127.0.0.1:9010/sys/test/clearPermission

3.20.4. 获取当前用户信息

URL: http://127.0.0.1:9010/sys/test/users/current

Type: GET

Author: Kaiser（wang shao）

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 获取当前用户信息

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Response-example:

string

Curl-example:

curl -X GET -H 'Authorization' -i http://127.0.0.1:9010/sys/test/users/current

3.20.5.

URL: http://127.0.0.1:9010/sys/test/user/get

Type: GET

Author: Kaiser（wang shao）

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description:

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Query-parameters:

Parameter

Value

Type

Required

Description

username

string

false

No comments found.

Response-example:

string

Curl-example:

curl -X GET -H 'Authorization' -i http://127.0.0.1:9010/sys/test/user/get?username=marg.collier

3.20.6.

URL: http://127.0.0.1:9010/sys/test/users/current/menutrees/{terminalCode}

Type: GET

Author: Kaiser（wang shao）

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description:

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Path-parameters:

Parameter

Value

Type

Required

Description

terminalCode

string

true

No comments found.

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

array

响应数据

└─id

int64

权限ID

└─parentId

int64

No comments found.

└─code

string

权限编号

└─name

string

权限名称

└─sortNo

int32

排序

└─pattern

string

路由

└─isHidden

boolean

菜单是否隐藏

└─isQuick

boolean

菜单是否隐藏

└─icon

string

图标

└─terminalCode

string

No comments found.

└─childNodes

array

当前子节点数据

time

string

响应时间

Response-example:

{
  "code": 633,
  "msg": "g1dcsp",
  "errorMsg": "2iavqx",
  "success": true,
  "errorNo": "mzu2ai",
  "data": [
    {
      "id": 306,
      "parentId": 22,
      "code": "99507",
      "name": "marg.collier",
      "sortNo": 955,
      "pattern": "h9yh8k",
      "isHidden": true,
      "isQuick": true,
      "icon": "9quft0",
      "terminalCode": "99507",
      "childNodes": [
        {
          "$ref": ".."
        }
      ]
    }
  ],
  "time": "2023-02-13 08:31:52"
}

Curl-example:

curl -X GET -H 'Authorization' -i http://127.0.0.1:9010/sys/test/users/current/menutrees/99507

3.20.7.

URL: http://127.0.0.1:9010/sys/test/users/current/menus/{terminalCode}

Type: GET

Author: Kaiser（wang shao）

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description:

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Path-parameters:

Parameter

Value

Type

Required

Description

terminalCode

string

true

No comments found.

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

array

响应数据

└─id

int64

权限ID

└─parentId

int64

No comments found.

└─code

string

权限编号

└─name

string

权限名称

└─sortNo

int32

排序

└─pattern

string

路由

└─isHidden

boolean

菜单是否隐藏

└─isQuick

boolean

菜单是否隐藏

└─icon

string

图标

└─terminalCode

string

No comments found.

└─childNodes

array

当前子节点数据

time

string

响应时间

Response-example:

{
  "code": 296,
  "msg": "lxa6uf",
  "errorMsg": "n4brx8",
  "success": true,
  "errorNo": "kw8xth",
  "data": [
    {
      "id": 64,
      "parentId": 336,
      "code": "99507",
      "name": "marg.collier",
      "sortNo": 628,
      "pattern": "jnvgs7",
      "isHidden": true,
      "isQuick": true,
      "icon": "drdc9z",
      "terminalCode": "99507",
      "childNodes": [
        {
          "$ref": ".."
        }
      ]
    }
  ],
  "time": "2023-02-13 08:31:52"
}

Curl-example:

curl -X GET -H 'Authorization' -i http://127.0.0.1:9010/sys/test/users/current/menus/99507

3.20.8.

URL: http://127.0.0.1:9010/sys/test/users/current/menus/{menuId}/{terminalCode}

Type: GET

Author: Kaiser（wang shao）

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description:

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Path-parameters:

Parameter

Value

Type

Required

Description

menuId

int64

true

No comments found.

terminalCode

string

true

No comments found.

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

array

响应数据

└─id

int64

权限ID

└─parentId

int64

No comments found.

└─code

string

权限编号

└─name

string

权限名称

└─sortNo

int32

排序

└─pattern

string

路由

└─isHidden

boolean

菜单是否隐藏

└─isQuick

boolean

菜单是否隐藏

└─icon

string

图标

└─terminalCode

string

No comments found.

└─childNodes

array

当前子节点数据

time

string

响应时间

Response-example:

{
  "code": 552,
  "msg": "j2e83w",
  "errorMsg": "7hq11x",
  "success": true,
  "errorNo": "bbjkp4",
  "data": [
    {
      "id": 51,
      "parentId": 464,
      "code": "99507",
      "name": "marg.collier",
      "sortNo": 993,
      "pattern": "3ra52l",
      "isHidden": true,
      "isQuick": true,
      "icon": "m0q720",
      "terminalCode": "99507",
      "childNodes": [
        {
          "$ref": ".."
        }
      ]
    }
  ],
  "time": "2023-02-13 08:31:52"
}

Curl-example:

curl -X GET -H 'Authorization' -i http://127.0.0.1:9010/sys/test/users/current/menus/341/99507

3.20.9.

URL: http://127.0.0.1:9010/sys/test/users/paging

Type: POST

Author: Kaiser（wang shao）

Content-Type: application/json

Description:

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Body-parameters:

Parameter

Type

Required

Description

current

int32

false

页码

size

int32

false

页大小

keyword

string

false

搜索关键字

orders

array

false

排序

└─column

string

false

属性名称

└─asc

boolean

false

是否升序

username

string

false

No comments found.

name

string

false

No comments found.

mobile

string

false

No comments found.

string

false

No comments found.

tenantId

int64

false

No comments found.

tenantName

string

false

No comments found.

enabled

boolean

false

No comments found.

roleCodeName

string

false

No comments found.

dataRoleCodeName

string

false

No comments found.

flowRoleCodeName

string

false

No comments found.

ouName

string

false

No comments found.

userType

string

false

No comments found.

Request-body:

{
  "current": 403,
  "size": 10,
  "keyword": "6gso9x",
  "orders": [
    {
      "column": "va91ds",
      "asc": true
    }
  ],
  "username": "marg.collier",
  "name": "marg.collier",
  "mobile": "(734) 208-3091",
  "email": "celinda.goldner@gmail.com",
  "tenantId": 319,
  "tenantName": "marg.collier",
  "enabled": true,
  "roleCodeName": "marg.collier",
  "dataRoleCodeName": "marg.collier",
  "flowRoleCodeName": "marg.collier",
  "ouName": "marg.collier",
  "userType": "ljwe6k"
}

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

└─total

int64

总记录数

└─records

array

数据列表

└─id

int64

用户ID

└─username

string

用户账号

└─lastName

string

用户姓氏

└─firstName

string

用户名称

└─mobile

string

手机号

└─email

string

电子邮箱

└─roleNames

string

角色名称列表

└─dataRoleNames

string

角色名称列表

└─flowRoleNames

string

流程角色名称列表

└─enabled

boolean

用户账号启用状态

└─ouId

int64

用户所属公司ID

└─ouCode

string

用户所属公司编号

└─ouName

string

用户所属公司名称

└─tenantId

int64

No comments found.

└─tenantName

string

No comments found.

└─buId

int64

用户所属组织ID

time

string

响应时间

Response-example:

{
  "code": 810,
  "msg": "5hshot",
  "errorMsg": "08p9fc",
  "success": true,
  "errorNo": "qj90x1",
  "data": {
    "total": 729,
    "records": [
      {
        "id": 927,
        "username": "marg.collier",
        "lastName": "marg.collier",
        "firstName": "marg.collier",
        "mobile": "(734) 208-3091",
        "email": "celinda.goldner@gmail.com",
        "roleNames": "pq3j5t",
        "dataRoleNames": "a9hrlm",
        "flowRoleNames": "0r24nz",
        "enabled": true,
        "ouId": 373,
        "ouCode": "99507",
        "ouName": "marg.collier",
        "tenantId": 747,
        "tenantName": "marg.collier",
        "buId": 679
      }
    ]
  },
  "time": "2023-02-13 08:31:52"
}

Curl-example:

curl -X POST -H 'Content-Type: application/json' -H 'Authorization' -i http://127.0.0.1:9010/sys/test/users/paging --data '{
  "current": 403,
  "size": 10,
  "keyword": "6gso9x",
  "orders": [
    {
      "column": "va91ds",
      "asc": true
    }
  ],
  "username": "marg.collier",
  "name": "marg.collier",
  "mobile": "(734) 208-3091",
  "email": "celinda.goldner@gmail.com",
  "tenantId": 319,
  "tenantName": "marg.collier",
  "enabled": true,
  "roleCodeName": "marg.collier",
  "dataRoleCodeName": "marg.collier",
  "flowRoleCodeName": "marg.collier",
  "ouName": "marg.collier",
  "userType": "ljwe6k"
}'

3.20.10.

URL: http://127.0.0.1:9010/sys/test/user/paging

Type: POST

Author: Kaiser（wang shao）

Content-Type: application/json

Description:

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Body-parameters:

Parameter

Type

Required

Description

current

int32

false

页码

size

int32

false

页大小

keyword

string

false

搜索关键字

orders

array

false

排序

└─column

string

false

属性名称

└─asc

boolean

false

是否升序

username

string

false

No comments found.

firstName

string

false

No comments found.

lastName

string

false

No comments found.

mobile

string

false

No comments found.

string

false

No comments found.

Request-body:

{
  "current": 823,
  "size": 10,
  "keyword": "xnl97m",
  "orders": [
    {
      "column": "zucl3c",
      "asc": true
    }
  ],
  "username": "marg.collier",
  "firstName": "marg.collier",
  "lastName": "marg.collier",
  "mobile": "(734) 208-3091",
  "email": "celinda.goldner@gmail.com"
}

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

└─total

int64

总记录数

└─records

array

数据列表

└─id

int64

No comments found.

└─username

string

No comments found.

└─lastName

string

No comments found.

└─firstName

string

No comments found.

└─mobile

string

No comments found.

└─email

string

No comments found.

time

string

响应时间

Response-example:

{
  "code": 175,
  "msg": "1cbaoz",
  "errorMsg": "zhbmpt",
  "success": true,
  "errorNo": "ks3wyh",
  "data": {
    "total": 388,
    "records": [
      {
        "id": 293,
        "username": "marg.collier",
        "lastName": "marg.collier",
        "firstName": "marg.collier",
        "mobile": "(734) 208-3091",
        "email": "celinda.goldner@gmail.com"
      }
    ]
  },
  "time": "2023-02-13 08:31:52"
}

Curl-example:

curl -X POST -H 'Content-Type: application/json' -H 'Authorization' -i http://127.0.0.1:9010/sys/test/user/paging --data '{
  "current": 823,
  "size": 10,
  "keyword": "xnl97m",
  "orders": [
    {
      "column": "zucl3c",
      "asc": true
    }
  ],
  "username": "marg.collier",
  "firstName": "marg.collier",
  "lastName": "marg.collier",
  "mobile": "(734) 208-3091",
  "email": "celinda.goldner@gmail.com"
}'

3.20.11.

URL: http://127.0.0.1:9010/sys/test/users/details/{id}

Type: GET

Author: Kaiser（wang shao）

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description:

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Path-parameters:

Parameter

Value

Type

Required

Description

int64

true

No comments found.

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

└─id

int64

用户ID

└─lastName

string

用户姓氏

└─firstName

string

用户名称

└─mobile

string

用户手机号码

└─email

string

用户邮箱地址

└─password

string

用户账号密码

└─enabled

boolean

是否启动

└─ouId

int64

用户所属公司ID

└─ouCode

string

用户所属公司编号

└─ouName

string

用户所属公司名称

└─buId

int64

用户所属组织ID

└─roleIds

array

功能角色ID列表

└─dataRoleIds

array

数据角色ID列表

└─flowRoleIds

array

流程角色ID列表

└─avatarUrl

string

No comments found.

└─avatarCode

string

No comments found.

└─terminals

array

用户的终端
BACKEND
APP
APPLET

time

string

响应时间

Response-example:

{
  "code": 363,
  "msg": "8e3urr",
  "errorMsg": "k6385n",
  "success": true,
  "errorNo": "neid1j",
  "data": {
    "id": 110,
    "lastName": "marg.collier",
    "firstName": "marg.collier",
    "mobile": "(734) 208-3091",
    "email": "celinda.goldner@gmail.com",
    "password": "1wophw",
    "enabled": true,
    "ouId": 776,
    "ouCode": "99507",
    "ouName": "marg.collier",
    "buId": 446,
    "roleIds": [
      "skhtua"
    ],
    "dataRoleIds": [
      "5esl3b"
    ],
    "flowRoleIds": [
      "q0rgqb"
    ],
    "avatarUrl": "www.williams-bashirian.biz",
    "avatarCode": "99507",
    "terminals": [
      "BACKEND"
    ]
  },
  "time": "2023-02-13 08:31:52"
}

Curl-example:

curl -X GET -H 'Authorization' -i http://127.0.0.1:9010/sys/test/users/details/363

3.20.12.

URL: http://127.0.0.1:9010/sys/test/roles/q

Type: POST

Author: Kaiser（wang shao）

Content-Type: application/json

Description:

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Body-parameters:

Parameter

Type

Required

Description

current

int32

false

页码

size

int32

false

页大小

keyword

string

false

搜索关键字

orders

array

false

排序

└─column

string

false

属性名称

└─asc

boolean

false

是否升序

code

string

false

No comments found.

name

string

false

No comments found.

tenantId

int64

false

No comments found.

tenantName

string

false

No comments found.

enabled

boolean

false

No comments found.

Request-body:

{
  "current": 998,
  "size": 10,
  "keyword": "66wclj",
  "orders": [
    {
      "column": "e692pu",
      "asc": true
    }
  ],
  "code": "99507",
  "name": "marg.collier",
  "tenantId": 294,
  "tenantName": "marg.collier",
  "enabled": true
}

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

└─total

int64

总记录数

└─records

array

数据列表

└─id

int64

No comments found.

└─code

string

No comments found.

└─name

string

No comments found.

└─tenantId

int64

No comments found.

└─tenantName

string

No comments found.

└─enabled

boolean

No comments found.

time

string

响应时间

Response-example:

{
  "code": 835,
  "msg": "sxbpio",
  "errorMsg": "eqypex",
  "success": true,
  "errorNo": "3rfjpx",
  "data": {
    "total": 40,
    "records": [
      {
        "id": 830,
        "code": "99507",
        "name": "marg.collier",
        "tenantId": 42,
        "tenantName": "marg.collier",
        "enabled": true
      }
    ]
  },
  "time": "2023-02-13 08:31:52"
}

Curl-example:

curl -X POST -H 'Content-Type: application/json' -H 'Authorization' -i http://127.0.0.1:9010/sys/test/roles/q --data '{
  "current": 998,
  "size": 10,
  "keyword": "66wclj",
  "orders": [
    {
      "column": "e692pu",
      "asc": true
    }
  ],
  "code": "99507",
  "name": "marg.collier",
  "tenantId": 294,
  "tenantName": "marg.collier",
  "enabled": true
}'

3.20.13.

URL: http://127.0.0.1:9010/sys/test/permissions/menutree/{terminalCode}

Type: GET

Author: Kaiser（wang shao）

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description:

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Path-parameters:

Parameter

Value

Type

Required

Description

terminalCode

string

true

No comments found.

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

array

响应数据

└─key

int64

└─code

string

编号

└─title

string

名称/标题

└─level

int32

深度等级

└─parentKey

int64

父级Key，指父级ID

└─sortNo

int32

排序号

└─icon

string

图标

└─terminalCode

string

No comments found.

└─isQuick

boolean

菜单是否隐藏

└─children

array

子节点

time

string

响应时间

Response-example:

{
  "code": 541,
  "msg": "jt215p",
  "errorMsg": "x0bb7n",
  "success": true,
  "errorNo": "rtg77o",
  "data": [
    {
      "key": 488,
      "code": "99507",
      "title": "bohzi1",
      "level": 845,
      "parentKey": 729,
      "sortNo": 164,
      "icon": "txn685",
      "terminalCode": "99507",
      "isQuick": true,
      "children": [
        {
          "$ref": ".."
        }
      ]
    }
  ],
  "time": "2023-02-13 08:31:52"
}

Curl-example:

curl -X GET -H 'Authorization' -i http://127.0.0.1:9010/sys/test/permissions/menutree/99507

3.20.14.

URL: http://127.0.0.1:9010/sys/test/roles/{id}/menuids

Type: GET

Author: Kaiser（wang shao）

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description:

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Path-parameters:

Parameter

Value

Type

Required

Description

int64

true

No comments found.

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

array

响应数据

time

string

响应时间

Response-example:

{
  "code": 407,
  "msg": "iru52m",
  "errorMsg": "j3lpay",
  "success": true,
  "errorNo": "bc5ajj",
  "data": [
    "irdu8u",
    "2jms9s"
  ],
  "time": "2023-02-13 08:31:52"
}

Curl-example:

curl -X GET -H 'Authorization' -i http://127.0.0.1:9010/sys/test/roles/42/menuids

3.20.15.

URL: http://127.0.0.1:9010/sys/test/roles/{id}/actionids

Type: GET

Author: Kaiser（wang shao）

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description:

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Path-parameters:

Parameter

Value

Type

Required

Description

int64

true

No comments found.

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

array

响应数据

time

string

响应时间

Response-example:

{
  "code": 892,
  "msg": "kvlbfu",
  "errorMsg": "u0su4u",
  "success": true,
  "errorNo": "rbfkf1",
  "data": [
    "2r3erv",
    "cdwtna"
  ],
  "time": "2023-02-13 08:31:52"
}

Curl-example:

curl -X GET -H 'Authorization' -i http://127.0.0.1:9010/sys/test/roles/846/actionids

3.20.16.

URL: http://127.0.0.1:9010/sys/test/roles/{id}/menus/{menuId}

Type: GET

Author: Kaiser（wang shao）

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description:

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Path-parameters:

Parameter

Value

Type

Required

Description

int64

true

No comments found.

menuId

int64

true

No comments found.

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

array

响应数据

└─id

int64

权限ID

└─code

string

权限代码

└─name

string

权限名称

└─permType

int32

权限类型: 1.菜单；0.按钮或API调用

└─parentId

int64

父权限ID

└─parentName

string

父权限名称"

└─path

string

权限层级路径

└─permLevel

int32

权限层级

└─sortNo

int32

排列顺序

└─pattern

string

URL路径

└─httpMethod

string

URL的HTTP方法

└─isHidden

boolean

菜单是否隐藏

└─icon

string

菜单图标

└─terminalCode

string

No comments found.

└─menuDepth

int32

菜单深度

└─isQuick

boolean

菜单是否隐藏

time

string

响应时间

Response-example:

{
  "code": 103,
  "msg": "bc9xg8",
  "errorMsg": "92380u",
  "success": true,
  "errorNo": "k80o3r",
  "data": [
    {
      "id": 409,
      "code": "99507",
      "name": "marg.collier",
      "permType": 423,
      "parentId": 548,
      "parentName": "marg.collier",
      "path": "l86h34",
      "permLevel": 564,
      "sortNo": 535,
      "pattern": "l7cek4",
      "httpMethod": "g6fb2c",
      "isHidden": true,
      "icon": "8nri3p",
      "terminalCode": "99507",
      "menuDepth": 567,
      "isQuick": true
    }
  ],
  "time": "2023-02-13 08:31:52"
}

Curl-example:

curl -X GET -H 'Authorization' -i http://127.0.0.1:9010/sys/test/roles/368/menus/543

3.20.17.

URL: http://127.0.0.1:9010/sys/test/roles/all

Type: GET

Author: Kaiser（wang shao）

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description:

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

array

响应数据

└─id

int64

No comments found.

└─code

string

No comments found.

└─name

string

No comments found.

└─tenantName

string

No comments found.

└─enabled

boolean

No comments found.

└─users

array

No comments found.

└─id

int64

记录唯一ID

└─tenantId

int64

租户ID

└─remark

string

备注

└─createUserId

int64

记录创建者ID

└─creator

string

记录创建者

└─createTime

string

记录创建时间

└─modifyUserId

int64

记录最后更新者ID

└─updater

string

记录最后更新者

└─modifyTime

string

记录最后更新时间

└─deleteFlag

int32

逻辑删除标识

└─auditDataVersion

int32

锁版本

└─username

string

No comments found.

└─lastName

string

No comments found.

└─firstName

string

No comments found.

└─mobile

string

No comments found.

└─email

string

No comments found.

└─roleNames

string

No comments found.

└─roleIds

string

No comments found.

└─wxOpenid

string

No comments found.

└─tenantName

string

No comments found.

└─enabled

boolean

No comments found.

└─roles

array

No comments found.

└─id

int64

No comments found.

└─code

string

No comments found.

└─name

string

No comments found.

└─tenantName

string

No comments found.

└─enabled

boolean

No comments found.

└─users

array

No comments found.

└─permIds

array

No comments found.

└─permissions

array

No comments found.

└─id

int64

权限ID

└─code

string

权限代码

└─name

string

权限名称

└─permType

int32

权限类型: 1.菜单；0.按钮或API调用

└─parentId

int64

父权限ID

└─parentName

string

父权限名称"

└─path

string

权限层级路径

└─permLevel

int32

权限层级

└─sortNo

int32

排列顺序

└─pattern

string

URL路径

└─httpMethod

string

URL的HTTP方法

└─isHidden

boolean

菜单是否隐藏

└─icon

string

菜单图标

└─terminalCode

string

No comments found.

└─menuDepth

int32

菜单深度

└─isQuick

boolean

菜单是否隐藏

└─noPermission

boolean

操作人是否有对应的权限

└─permissions

array

No comments found.

└─id

int64

权限ID

└─code

string

权限代码

└─name

string

权限名称

└─permType

int32

权限类型: 1.菜单；0.按钮或API调用

└─parentId

int64

父权限ID

└─parentName

string

父权限名称"

└─path

string

权限层级路径

└─permLevel

int32

权限层级

└─sortNo

int32

排列顺序

└─pattern

string

URL路径

└─httpMethod

string

URL的HTTP方法

└─isHidden

boolean

菜单是否隐藏

└─icon

string

菜单图标

└─terminalCode

string

No comments found.

└─menuDepth

int32

菜单深度

└─isQuick

boolean

菜单是否隐藏

└─permIds

array

No comments found.

└─permissions

array

No comments found.

└─id

int64

权限ID

└─code

string

权限代码

└─name

string

权限名称

└─permType

int32

权限类型: 1.菜单；0.按钮或API调用

└─parentId

int64

父权限ID

└─parentName

string

父权限名称"

└─path

string

权限层级路径

└─permLevel

int32

权限层级

└─sortNo

int32

排列顺序

└─pattern

string

URL路径

└─httpMethod

string

URL的HTTP方法

└─isHidden

boolean

菜单是否隐藏

└─icon

string

菜单图标

└─terminalCode

string

No comments found.

└─menuDepth

int32

菜单深度

└─isQuick

boolean

菜单是否隐藏

└─noPermission

boolean

操作人是否有对应的权限

time

string

响应时间

Response-example:

{
  "code": 804,
  "msg": "ves48e",
  "errorMsg": "owvjel",
  "success": true,
  "errorNo": "5fgtxe",
  "data": [
    {
      "id": 655,
      "code": "99507",
      "name": "marg.collier",
      "tenantName": "marg.collier",
      "enabled": true,
      "users": [
        {
          "id": 206,
          "tenantId": 581,
          "remark": "n7gn49",
          "createUserId": 252,
          "creator": "ro4gi3",
          "createTime": "2023-02-13 08:31:52",
          "modifyUserId": 546,
          "updater": "iexqxt",
          "modifyTime": "2023-02-13 08:31:52",
          "deleteFlag": 9,
          "auditDataVersion": 623,
          "username": "marg.collier",
          "lastName": "marg.collier",
          "firstName": "marg.collier",
          "mobile": "(734) 208-3091",
          "email": "celinda.goldner@gmail.com",
          "roleNames": "k74yxk",
          "roleIds": "5z3hfi",
          "wxOpenid": "173",
          "tenantName": "marg.collier",
          "enabled": true,
          "roles": [
            {
              "id": 761,
              "code": "99507",
              "name": "marg.collier",
              "tenantName": "marg.collier",
              "enabled": true,
              "users": [
                {
                  "$ref": "..."
                }
              ],
              "permIds": [
                805
              ],
              "permissions": [
                {
                  "id": 958,
                  "code": "99507",
                  "name": "marg.collier",
                  "permType": 881,
                  "parentId": 302,
                  "parentName": "marg.collier",
                  "path": "o7vxqc",
                  "permLevel": 535,
                  "sortNo": 171,
                  "pattern": "5t2hma",
                  "httpMethod": "1dpter",
                  "isHidden": true,
                  "icon": "xlixha",
                  "terminalCode": "99507",
                  "menuDepth": 347,
                  "isQuick": true
                }
              ],
              "noPermission": true
            }
          ],
          "permissions": [
            {
              "id": 128,
              "code": "99507",
              "name": "marg.collier",
              "permType": 49,
              "parentId": 924,
              "parentName": "marg.collier",
              "path": "8xcymp",
              "permLevel": 665,
              "sortNo": 197,
              "pattern": "7lu0ko",
              "httpMethod": "3aqxdz",
              "isHidden": true,
              "icon": "caf4xv",
              "terminalCode": "99507",
              "menuDepth": 96,
              "isQuick": true
            }
          ]
        }
      ],
      "permIds": [
        84
      ],
      "permissions": [
        {
          "id": 585,
          "code": "99507",
          "name": "marg.collier",
          "permType": 397,
          "parentId": 272,
          "parentName": "marg.collier",
          "path": "4q6nkt",
          "permLevel": 371,
          "sortNo": 225,
          "pattern": "zrmcfa",
          "httpMethod": "ock1s9",
          "isHidden": true,
          "icon": "j1n679",
          "terminalCode": "99507",
          "menuDepth": 383,
          "isQuick": true
        }
      ],
      "noPermission": true
    }
  ],
  "time": "2023-02-13 08:31:52"
}

Curl-example:

curl -X GET -H 'Authorization' -i http://127.0.0.1:9010/sys/test/roles/all

3.20.18.

URL: http://127.0.0.1:9010/sys/test/reids/keys

Type: GET

Author: Kaiser（wang shao）

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description:

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Query-parameters:

Parameter

Value

Type

Required

Description

prefix

string

false

No comments found.

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

array

响应数据

time

string

响应时间

Response-example:

{
  "code": 870,
  "msg": "fn5tnq",
  "errorMsg": "fc63yc",
  "success": true,
  "errorNo": "v65vyf",
  "data": [
    "dik3mv",
    "q42r71"
  ],
  "time": "2023-02-13 08:31:52"
}

Curl-example:

curl -X GET -H 'Authorization' -i http://127.0.0.1:9010/sys/test/reids/keys?prefix=6ni861

3.20.19. 测试redis值操作

URL: http://127.0.0.1:9010/sys/test/测试redis值操作

Type: GET

Author: Kaiser（wang shao）

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 测试redis值操作

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Query-parameters:

Parameter

Value

Type

Required

Description

key

string

false

key

value

string

false

value，空时取值

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

string

响应数据

time

string

响应时间

Response-example:

{
  "code": 759,
  "msg": "hujqpg",
  "errorMsg": "76muyj",
  "success": true,
  "errorNo": "y6t93v",
  "data": "pao13e",
  "time": "2023-02-13 08:31:52"
}

Curl-example:

curl -X GET -H 'Authorization' -i http://127.0.0.1:9010/sys/test/测试redis值操作?key=6e3z1u&value=l4gfe4

3.20.20.

URL: http://127.0.0.1:9010/sys/test/mq/send

Type: GET

Author: Kaiser（wang shao）

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description:

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

string

响应数据

time

string

响应时间

Response-example:

{
  "code": 940,
  "msg": "wxe8be",
  "errorMsg": "q1q9cf",
  "success": true,
  "errorNo": "tnvirl",
  "data": "drea6t",
  "time": "2023-02-13 08:31:52"
}

Curl-example:

curl -X GET -H 'Authorization' -i http://127.0.0.1:9010/sys/test/mq/send

3.20.21.

URL: http://127.0.0.1:9010/sys/test/server/info

Type: GET

Author: Kaiser（wang shao）

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description:

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

└─mapKey

object

A map key.

└─any object

object

any object.

time

string

响应时间

Response-example:

{
  "code": 769,
  "msg": "2s2w80",
  "errorMsg": "6nc7ww",
  "success": true,
  "errorNo": "n3ynso",
  "data": {
    "mapKey": {
      "waring": "You may use java.util.Object for Map value; smart-doc can't be handle."
    }
  },
  "time": "2023-02-13 08:31:52"
}

Curl-example:

curl -X GET -H 'Authorization' -i http://127.0.0.1:9010/sys/test/server/info

3.21. 功能说明

3.21.1. 通过主键查询单条数据

URL: http://127.0.0.1:9010/com.elitesland.yst.system/sysUserProxy/findIdOne/{id}

Type: GET

Author: roman.zhang

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 通过主键查询单条数据

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Path-parameters:

Parameter

Value

Type

Required

Description

int64

true

主键

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

└─id

int64

记录唯一ID

└─userId

int64

被代理人id

└─username

string

被代理人用户账号名称

└─mobile

string

被代理人用户手机号码

└─email

string

被代理人用户邮箱地址

└─ouId

int64

被代理人用户所属公司ID

└─ouCode

string

被代理人用户所属公司编号

└─ouName

string

被代理人用户所属公司名称

└─buId

int64

被代理人用户所属组织ID

└─proxyUserId

int64

代理人id

└─proxyUsername

string

代理人用户账号名称

└─proxyMobile

string

代理人用户手机号码

└─proxyEmail

string

代理人用户邮箱地址

└─proxyOuId

int64

代理人用户所属公司ID

└─proxyOuCode

string

代理人用户所属公司编号

└─proxyOuName

string

代理人用户所属公司名称

└─proxyBuId

int64

代理人用户所属组织ID

└─tenantId

int64

租户ID

└─remark

string

备注

└─createUserId

int64

记录创建者ID

└─creator

string

记录创建者

└─createTime

string

记录创建时间

└─modifyUserId

int64

记录最后更新者ID

└─updater

string

记录最后更新者

└─modifyTime

string

记录最后更新时间

└─deleteFlag

int32

逻辑删除，0：未删除，1：已删除

└─auditDataVersion

int32

锁版本

└─secBuId

int64

sec_bu_id

└─secUserId

int64

sec_user_id

└─secOuId

int64

sec_ou_id

└─openFlag

boolean

No comments found.

└─effectStartTime

string

No comments found.

└─effectEndTime

string

No comments found.

time

string

响应时间

Response-example:

{
  "code": 16,
  "msg": "dglf4y",
  "errorMsg": "z86hwp",
  "success": true,
  "errorNo": "0pjbhw",
  "data": {
    "id": 39,
    "userId": 719,
    "username": "marg.collier",
    "mobile": "(734) 208-3091",
    "email": "celinda.goldner@gmail.com",
    "ouId": 131,
    "ouCode": "99507",
    "ouName": "marg.collier",
    "buId": 397,
    "proxyUserId": 823,
    "proxyUsername": "marg.collier",
    "proxyMobile": "(734) 208-3091",
    "proxyEmail": "celinda.goldner@gmail.com",
    "proxyOuId": 220,
    "proxyOuCode": "99507",
    "proxyOuName": "marg.collier",
    "proxyBuId": 765,
    "tenantId": 965,
    "remark": "ro7v2t",
    "createUserId": 749,
    "creator": "mr6tmk",
    "createTime": "2023-02-13 08:31:52",
    "modifyUserId": 203,
    "updater": "n0lnms",
    "modifyTime": "2023-02-13 08:31:52",
    "deleteFlag": 9,
    "auditDataVersion": 524,
    "secBuId": 217,
    "secUserId": 637,
    "secOuId": 112,
    "openFlag": true,
    "effectStartTime": "2023-02-13 08:31:52",
    "effectEndTime": "2023-02-13 08:31:52"
  },
  "time": "2023-02-13 08:31:52"
}

Curl-example:

curl -X GET -H 'Authorization' -i http://127.0.0.1:9010/com.elitesland.yst.system/sysUserProxy/findIdOne/629

3.21.2. 分页查询

URL: http://127.0.0.1:9010/com.elitesland.yst.system/sysUserProxy/search

Type: POST

Author: roman.zhang

Content-Type: application/json

Description: 分页查询

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Body-parameters:

Parameter

Type

Required

Description

current

int32

false

页码

size

int32

false

页大小

keyword

string

false

搜索关键字

orders

array

false

排序

└─column

string

false

属性名称

└─asc

boolean

false

是否升序

int64

false

记录唯一ID

userId

int64

false

被代理人id

username

string

false

被代理人用户账号名称

mobile

string

false

被代理人用户手机号码

string

false

被代理人用户邮箱地址

ouId

int64

false

被代理人用户所属公司ID

ouCode

string

false

被代理人用户所属公司编号

ouName

string

false

被代理人用户所属公司名称

buId

int64

false

被代理人用户所属组织ID

proxyUserId

int64

false

代理人id

proxyUsername

string

false

代理人用户账号名称

proxyMobile

string

false

代理人用户手机号码

proxyEmail

string

false

代理人用户邮箱地址

proxyOuId

int64

false

代理人用户所属公司ID

proxyOuCode

string

false

代理人用户所属公司编号

proxyOuName

string

false

代理人用户所属公司名称

proxyBuId

int64

false

代理人用户所属组织ID

tenantId

int64

false

租户ID

remark

string

false

备注

createUserId

int64

false

记录创建者ID

creator

string

false

记录创建者

createTime

string

false

记录创建时间

modifyUserId

int64

false

记录最后更新者ID

updater

string

false

记录最后更新者

modifyTime

string

false

记录最后更新时间

deleteFlag

int32

false

逻辑删除，0：未删除，1：已删除

auditDataVersion

int32

false

锁版本

secBuId

int64

false

sec_bu_id

secUserId

int64

false

sec_user_id

secOuId

int64

false

sec_ou_id

openFlag

boolean

false

No comments found.

effectStartTime

string

false

No comments found.

effectEndTime

string

false

No comments found.

Request-body:

{
  "current": 505,
  "size": 10,
  "keyword": "v4flt5",
  "orders": [
    {
      "column": "u6r4tn",
      "asc": true
    }
  ],
  "id": 56,
  "userId": 927,
  "username": "marg.collier",
  "mobile": "(734) 208-3091",
  "email": "celinda.goldner@gmail.com",
  "ouId": 261,
  "ouCode": "99507",
  "ouName": "marg.collier",
  "buId": 351,
  "proxyUserId": 121,
  "proxyUsername": "marg.collier",
  "proxyMobile": "(734) 208-3091",
  "proxyEmail": "celinda.goldner@gmail.com",
  "proxyOuId": 110,
  "proxyOuCode": "99507",
  "proxyOuName": "marg.collier",
  "proxyBuId": 702,
  "tenantId": 735,
  "remark": "995obp",
  "createUserId": 5,
  "creator": "c5s9ev",
  "createTime": "2023-02-13 08:31:52",
  "modifyUserId": 719,
  "updater": "o2r8l9",
  "modifyTime": "2023-02-13 08:31:52",
  "deleteFlag": 9,
  "auditDataVersion": 965,
  "secBuId": 878,
  "secUserId": 825,
  "secOuId": 364,
  "openFlag": true,
  "effectStartTime": "2023-02-13 08:31:52",
  "effectEndTime": "2023-02-13 08:31:52"
}

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

└─total

int64

总记录数

└─records

array

数据列表

└─id

int64

记录唯一ID

└─userId

int64

被代理人id

└─username

string

被代理人用户账号名称

└─mobile

string

被代理人用户手机号码

└─email

string

被代理人用户邮箱地址

└─ouId

int64

被代理人用户所属公司ID

└─ouCode

string

被代理人用户所属公司编号

└─ouName

string

被代理人用户所属公司名称

└─buId

int64

被代理人用户所属组织ID

└─proxyUserId

int64

代理人id

└─proxyUsername

string

代理人用户账号名称

└─proxyMobile

string

代理人用户手机号码

└─proxyEmail

string

代理人用户邮箱地址

└─proxyOuId

int64

代理人用户所属公司ID

└─proxyOuCode

string

代理人用户所属公司编号

└─proxyOuName

string

代理人用户所属公司名称

└─proxyBuId

int64

代理人用户所属组织ID

└─tenantId

int64

租户ID

└─remark

string

备注

└─createUserId

int64

记录创建者ID

└─creator

string

记录创建者

└─createTime

string

记录创建时间

└─modifyUserId

int64

记录最后更新者ID

└─updater

string

记录最后更新者

└─modifyTime

string

记录最后更新时间

└─deleteFlag

int32

逻辑删除，0：未删除，1：已删除

└─auditDataVersion

int32

锁版本

└─secBuId

int64

sec_bu_id

└─secUserId

int64

sec_user_id

└─secOuId

int64

sec_ou_id

└─openFlag

boolean

No comments found.

└─effectStartTime

string

No comments found.

└─effectEndTime

string

No comments found.

time

string

响应时间

Response-example:

{
  "code": 746,
  "msg": "8ulf9g",
  "errorMsg": "yl7qli",
  "success": true,
  "errorNo": "auf2v5",
  "data": {
    "total": 385,
    "records": [
      {
        "id": 683,
        "userId": 352,
        "username": "marg.collier",
        "mobile": "(734) 208-3091",
        "email": "celinda.goldner@gmail.com",
        "ouId": 218,
        "ouCode": "99507",
        "ouName": "marg.collier",
        "buId": 274,
        "proxyUserId": 307,
        "proxyUsername": "marg.collier",
        "proxyMobile": "(734) 208-3091",
        "proxyEmail": "celinda.goldner@gmail.com",
        "proxyOuId": 109,
        "proxyOuCode": "99507",
        "proxyOuName": "marg.collier",
        "proxyBuId": 423,
        "tenantId": 258,
        "remark": "j2oeqp",
        "createUserId": 265,
        "creator": "mjdsty",
        "createTime": "2023-02-13 08:31:52",
        "modifyUserId": 906,
        "updater": "xs31yc",
        "modifyTime": "2023-02-13 08:31:52",
        "deleteFlag": 9,
        "auditDataVersion": 712,
        "secBuId": 345,
        "secUserId": 654,
        "secOuId": 250,
        "openFlag": true,
        "effectStartTime": "2023-02-13 08:31:52",
        "effectEndTime": "2023-02-13 08:31:52"
      }
    ]
  },
  "time": "2023-02-13 08:31:52"
}

Curl-example:

curl -X POST -H 'Content-Type: application/json' -H 'Authorization' -i http://127.0.0.1:9010/com.elitesland.yst.system/sysUserProxy/search --data '{
  "current": 505,
  "size": 10,
  "keyword": "v4flt5",
  "orders": [
    {
      "column": "u6r4tn",
      "asc": true
    }
  ],
  "id": 56,
  "userId": 927,
  "username": "marg.collier",
  "mobile": "(734) 208-3091",
  "email": "celinda.goldner@gmail.com",
  "ouId": 261,
  "ouCode": "99507",
  "ouName": "marg.collier",
  "buId": 351,
  "proxyUserId": 121,
  "proxyUsername": "marg.collier",
  "proxyMobile": "(734) 208-3091",
  "proxyEmail": "celinda.goldner@gmail.com",
  "proxyOuId": 110,
  "proxyOuCode": "99507",
  "proxyOuName": "marg.collier",
  "proxyBuId": 702,
  "tenantId": 735,
  "remark": "995obp",
  "createUserId": 5,
  "creator": "c5s9ev",
  "createTime": "2023-02-13 08:31:52",
  "modifyUserId": 719,
  "updater": "o2r8l9",
  "modifyTime": "2023-02-13 08:31:52",
  "deleteFlag": 9,
  "auditDataVersion": 965,
  "secBuId": 878,
  "secUserId": 825,
  "secOuId": 364,
  "openFlag": true,
  "effectStartTime": "2023-02-13 08:31:52",
  "effectEndTime": "2023-02-13 08:31:52"
}'

3.21.3. 新增数据

URL: http://127.0.0.1:9010/com.elitesland.yst.system/sysUserProxy/createOne

Type: POST

Author: roman.zhang

Content-Type: application/json

Description: 新增数据

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Body-parameters:

Parameter

Type

Required

Description

int64

false

记录唯一ID

userId

int64

false

被代理人id

username

string

false

被代理人用户账号名称

mobile

string

false

被代理人用户手机号码

string

false

被代理人用户邮箱地址

ouId

int64

false

被代理人用户所属公司ID

ouCode

string

false

被代理人用户所属公司编号

ouName

string

false

被代理人用户所属公司名称

buId

int64

false

被代理人用户所属组织ID

proxyUserId

int64

false

代理人id

proxyUsername

string

false

代理人用户账号名称

proxyMobile

string

false

代理人用户手机号码

proxyEmail

string

false

代理人用户邮箱地址

proxyOuId

int64

false

代理人用户所属公司ID

proxyOuCode

string

false

代理人用户所属公司编号

proxyOuName

string

false

代理人用户所属公司名称

proxyBuId

int64

false

代理人用户所属组织ID

tenantId

int64

false

租户ID

remark

string

false

备注

createUserId

int64

false

记录创建者ID

creator

string

false

记录创建者

createTime

string

false

记录创建时间

modifyUserId

int64

false

记录最后更新者ID

updater

string

false

记录最后更新者

modifyTime

string

false

记录最后更新时间

deleteFlag

int32

false

逻辑删除，0：未删除，1：已删除

auditDataVersion

int32

false

锁版本

secBuId

int64

false

sec_bu_id

secUserId

int64

false

sec_user_id

secOuId

int64

false

sec_ou_id

openFlag

boolean

false

No comments found.

effectStartTime

string

false

No comments found.

effectEndTime

string

false

No comments found.

Request-body:

{
  "id": 521,
  "userId": 149,
  "username": "marg.collier",
  "mobile": "(734) 208-3091",
  "email": "celinda.goldner@gmail.com",
  "ouId": 693,
  "ouCode": "99507",
  "ouName": "marg.collier",
  "buId": 211,
  "proxyUserId": 716,
  "proxyUsername": "marg.collier",
  "proxyMobile": "(734) 208-3091",
  "proxyEmail": "celinda.goldner@gmail.com",
  "proxyOuId": 345,
  "proxyOuCode": "99507",
  "proxyOuName": "marg.collier",
  "proxyBuId": 158,
  "tenantId": 689,
  "remark": "sanh3m",
  "createUserId": 241,
  "creator": "3inqob",
  "createTime": "2023-02-13 08:31:52",
  "modifyUserId": 274,
  "updater": "yxb5px",
  "modifyTime": "2023-02-13 08:31:52",
  "deleteFlag": 9,
  "auditDataVersion": 465,
  "secBuId": 114,
  "secUserId": 525,
  "secOuId": 943,
  "openFlag": true,
  "effectStartTime": "2023-02-13 08:31:52",
  "effectEndTime": "2023-02-13 08:31:52"
}

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

└─any object

object

any object.

time

string

响应时间

Response-example:

{
  "code": 50,
  "msg": "8ff9x5",
  "errorMsg": "zwe7mv",
  "success": true,
  "errorNo": "za3pk0",
  "data": {},
  "time": "2023-02-13 08:31:52"
}

Curl-example:

curl -X POST -H 'Content-Type: application/json' -H 'Authorization' -i http://127.0.0.1:9010/com.elitesland.yst.system/sysUserProxy/createOne --data '{
  "id": 521,
  "userId": 149,
  "username": "marg.collier",
  "mobile": "(734) 208-3091",
  "email": "celinda.goldner@gmail.com",
  "ouId": 693,
  "ouCode": "99507",
  "ouName": "marg.collier",
  "buId": 211,
  "proxyUserId": 716,
  "proxyUsername": "marg.collier",
  "proxyMobile": "(734) 208-3091",
  "proxyEmail": "celinda.goldner@gmail.com",
  "proxyOuId": 345,
  "proxyOuCode": "99507",
  "proxyOuName": "marg.collier",
  "proxyBuId": 158,
  "tenantId": 689,
  "remark": "sanh3m",
  "createUserId": 241,
  "creator": "3inqob",
  "createTime": "2023-02-13 08:31:52",
  "modifyUserId": 274,
  "updater": "yxb5px",
  "modifyTime": "2023-02-13 08:31:52",
  "deleteFlag": 9,
  "auditDataVersion": 465,
  "secBuId": 114,
  "secUserId": 525,
  "secOuId": 943,
  "openFlag": true,
  "effectStartTime": "2023-02-13 08:31:52",
  "effectEndTime": "2023-02-13 08:31:52"
}'

3.21.4. 批量新增数据

URL: http://127.0.0.1:9010/com.elitesland.yst.system/sysUserProxy/createBatch

Type: POST

Author: roman.zhang

Content-Type: application/json

Description: 批量新增数据

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Body-parameters:

Parameter

Type

Required

Description

int64

false

记录唯一ID

userId

int64

false

被代理人id

username

string

false

被代理人用户账号名称

mobile

string

false

被代理人用户手机号码

string

false

被代理人用户邮箱地址

ouId

int64

false

被代理人用户所属公司ID

ouCode

string

false

被代理人用户所属公司编号

ouName

string

false

被代理人用户所属公司名称

buId

int64

false

被代理人用户所属组织ID

proxyUserId

int64

false

代理人id

proxyUsername

string

false

代理人用户账号名称

proxyMobile

string

false

代理人用户手机号码

proxyEmail

string

false

代理人用户邮箱地址

proxyOuId

int64

false

代理人用户所属公司ID

proxyOuCode

string

false

代理人用户所属公司编号

proxyOuName

string

false

代理人用户所属公司名称

proxyBuId

int64

false

代理人用户所属组织ID

tenantId

int64

false

租户ID

remark

string

false

备注

createUserId

int64

false

记录创建者ID

creator

string

false

记录创建者

createTime

string

false

记录创建时间

modifyUserId

int64

false

记录最后更新者ID

updater

string

false

记录最后更新者

modifyTime

string

false

记录最后更新时间

deleteFlag

int32

false

逻辑删除，0：未删除，1：已删除

auditDataVersion

int32

false

锁版本

secBuId

int64

false

sec_bu_id

secUserId

int64

false

sec_user_id

secOuId

int64

false

sec_ou_id

openFlag

boolean

false

No comments found.

effectStartTime

string

false

No comments found.

effectEndTime

string

false

No comments found.

Request-body:

[
  {
    "id": 622,
    "userId": 793,
    "username": "marg.collier",
    "mobile": "(734) 208-3091",
    "email": "celinda.goldner@gmail.com",
    "ouId": 213,
    "ouCode": "99507",
    "ouName": "marg.collier",
    "buId": 327,
    "proxyUserId": 98,
    "proxyUsername": "marg.collier",
    "proxyMobile": "(734) 208-3091",
    "proxyEmail": "celinda.goldner@gmail.com",
    "proxyOuId": 839,
    "proxyOuCode": "99507",
    "proxyOuName": "marg.collier",
    "proxyBuId": 730,
    "tenantId": 243,
    "remark": "uqca5w",
    "createUserId": 522,
    "creator": "jy877b",
    "createTime": "2023-02-13 08:31:52",
    "modifyUserId": 772,
    "updater": "h90hfo",
    "modifyTime": "2023-02-13 08:31:52",
    "deleteFlag": 9,
    "auditDataVersion": 355,
    "secBuId": 168,
    "secUserId": 244,
    "secOuId": 311,
    "openFlag": true,
    "effectStartTime": "2023-02-13 08:31:52",
    "effectEndTime": "2023-02-13 08:31:52"
  }
]

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

└─any object

object

any object.

time

string

响应时间

Response-example:

{
  "code": 103,
  "msg": "9o5ug7",
  "errorMsg": "4tpsk5",
  "success": true,
  "errorNo": "6ic4o9",
  "data": {},
  "time": "2023-02-13 08:31:52"
}

Curl-example:

curl -X POST -H 'Content-Type: application/json' -H 'Authorization' -i http://127.0.0.1:9010/com.elitesland.yst.system/sysUserProxy/createBatch --data '[
  {
    "id": 622,
    "userId": 793,
    "username": "marg.collier",
    "mobile": "(734) 208-3091",
    "email": "celinda.goldner@gmail.com",
    "ouId": 213,
    "ouCode": "99507",
    "ouName": "marg.collier",
    "buId": 327,
    "proxyUserId": 98,
    "proxyUsername": "marg.collier",
    "proxyMobile": "(734) 208-3091",
    "proxyEmail": "celinda.goldner@gmail.com",
    "proxyOuId": 839,
    "proxyOuCode": "99507",
    "proxyOuName": "marg.collier",
    "proxyBuId": 730,
    "tenantId": 243,
    "remark": "uqca5w",
    "createUserId": 522,
    "creator": "jy877b",
    "createTime": "2023-02-13 08:31:52",
    "modifyUserId": 772,
    "updater": "h90hfo",
    "modifyTime": "2023-02-13 08:31:52",
    "deleteFlag": 9,
    "auditDataVersion": 355,
    "secBuId": 168,
    "secUserId": 244,
    "secOuId": 311,
    "openFlag": true,
    "effectStartTime": "2023-02-13 08:31:52",
    "effectEndTime": "2023-02-13 08:31:52"
  }
]'

3.21.5. 修改数据

URL: http://127.0.0.1:9010/com.elitesland.yst.system/sysUserProxy/update

Type: PUT

Author: roman.zhang

Content-Type: application/json

Description: 修改数据

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Body-parameters:

Parameter

Type

Required

Description

int64

false

记录唯一ID

userId

int64

false

被代理人id

username

string

false

被代理人用户账号名称

mobile

string

false

被代理人用户手机号码

string

false

被代理人用户邮箱地址

ouId

int64

false

被代理人用户所属公司ID

ouCode

string

false

被代理人用户所属公司编号

ouName

string

false

被代理人用户所属公司名称

buId

int64

false

被代理人用户所属组织ID

proxyUserId

int64

false

代理人id

proxyUsername

string

false

代理人用户账号名称

proxyMobile

string

false

代理人用户手机号码

proxyEmail

string

false

代理人用户邮箱地址

proxyOuId

int64

false

代理人用户所属公司ID

proxyOuCode

string

false

代理人用户所属公司编号

proxyOuName

string

false

代理人用户所属公司名称

proxyBuId

int64

false

代理人用户所属组织ID

tenantId

int64

false

租户ID

remark

string

false

备注

createUserId

int64

false

记录创建者ID

creator

string

false

记录创建者

createTime

string

false

记录创建时间

modifyUserId

int64

false

记录最后更新者ID

updater

string

false

记录最后更新者

modifyTime

string

false

记录最后更新时间

deleteFlag

int32

false

逻辑删除，0：未删除，1：已删除

auditDataVersion

int32

false

锁版本

secBuId

int64

false

sec_bu_id

secUserId

int64

false

sec_user_id

secOuId

int64

false

sec_ou_id

openFlag

boolean

false

No comments found.

effectStartTime

string

false

No comments found.

effectEndTime

string

false

No comments found.

Request-body:

{
  "id": 542,
  "userId": 698,
  "username": "marg.collier",
  "mobile": "(734) 208-3091",
  "email": "celinda.goldner@gmail.com",
  "ouId": 230,
  "ouCode": "99507",
  "ouName": "marg.collier",
  "buId": 871,
  "proxyUserId": 358,
  "proxyUsername": "marg.collier",
  "proxyMobile": "(734) 208-3091",
  "proxyEmail": "celinda.goldner@gmail.com",
  "proxyOuId": 677,
  "proxyOuCode": "99507",
  "proxyOuName": "marg.collier",
  "proxyBuId": 53,
  "tenantId": 931,
  "remark": "4bgv6d",
  "createUserId": 282,
  "creator": "cy706q",
  "createTime": "2023-02-13 08:31:52",
  "modifyUserId": 558,
  "updater": "1ydab4",
  "modifyTime": "2023-02-13 08:31:52",
  "deleteFlag": 9,
  "auditDataVersion": 549,
  "secBuId": 255,
  "secUserId": 361,
  "secOuId": 624,
  "openFlag": true,
  "effectStartTime": "2023-02-13 08:31:52",
  "effectEndTime": "2023-02-13 08:31:52"
}

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

└─any object

object

any object.

time

string

响应时间

Response-example:

{
  "code": 935,
  "msg": "henoc8",
  "errorMsg": "kpmme8",
  "success": true,
  "errorNo": "6wzyem",
  "data": {},
  "time": "2023-02-13 08:31:52"
}

Curl-example:

curl -X PUT -H 'Content-Type: application/json' -H 'Authorization' -i http://127.0.0.1:9010/com.elitesland.yst.system/sysUserProxy/update --data '{
  "id": 542,
  "userId": 698,
  "username": "marg.collier",
  "mobile": "(734) 208-3091",
  "email": "celinda.goldner@gmail.com",
  "ouId": 230,
  "ouCode": "99507",
  "ouName": "marg.collier",
  "buId": 871,
  "proxyUserId": 358,
  "proxyUsername": "marg.collier",
  "proxyMobile": "(734) 208-3091",
  "proxyEmail": "celinda.goldner@gmail.com",
  "proxyOuId": 677,
  "proxyOuCode": "99507",
  "proxyOuName": "marg.collier",
  "proxyBuId": 53,
  "tenantId": 931,
  "remark": "4bgv6d",
  "createUserId": 282,
  "creator": "cy706q",
  "createTime": "2023-02-13 08:31:52",
  "modifyUserId": 558,
  "updater": "1ydab4",
  "modifyTime": "2023-02-13 08:31:52",
  "deleteFlag": 9,
  "auditDataVersion": 549,
  "secBuId": 255,
  "secUserId": 361,
  "secOuId": 624,
  "openFlag": true,
  "effectStartTime": "2023-02-13 08:31:52",
  "effectEndTime": "2023-02-13 08:31:52"
}'

3.21.6. 根据主键删除数据

URL: http://127.0.0.1:9010/com.elitesland.yst.system/sysUserProxy/deleteOne/{id}

Type: DELETE

Author: roman.zhang

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据主键删除数据

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Path-parameters:

Parameter

Value

Type

Required

Description

int64

true

主键

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

└─any object

object

any object.

time

string

响应时间

Response-example:

{
  "code": 218,
  "msg": "qjqgi2",
  "errorMsg": "zh3lb8",
  "success": true,
  "errorNo": "ze6k8t",
  "data": {},
  "time": "2023-02-13 08:31:52"
}

Curl-example:

curl -X DELETE -H 'Authorization' -i http://127.0.0.1:9010/com.elitesland.yst.system/sysUserProxy/deleteOne/948

3.21.7. 批量删除

URL: http://127.0.0.1:9010/com.elitesland.yst.system/sysUserProxy/deleteBatch

Type: DELETE

Author: roman.zhang

Content-Type: application/json

Description: 批量删除

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Body-parameters:

Parameter

Type

Required

Description

ids

array

false

删除数据集合,[array of int64]@since

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

└─any object

object

any object.

time

string

响应时间

Response-example:

{
  "code": 270,
  "msg": "u8gklv",
  "errorMsg": "g8jele",
  "success": true,
  "errorNo": "difp42",
  "data": {},
  "time": "2023-02-13 08:31:52"
}

Curl-example:

curl -X DELETE -H 'Content-Type: application/json' -H 'Authorization' -i http://127.0.0.1:9010/com.elitesland.yst.system/sysUserProxy/deleteBatch --data '[]'

3.21.8. 批量删除

URL: http://127.0.0.1:9010/com.elitesland.yst.system/sysUserProxy/batchOpen

Type: DELETE

Author: roman.zhang

Content-Type: application/json

Description: 批量删除

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Query-parameters:

Parameter

Value

Type

Required

Description

openFlag

int32

true

No comments found.

Body-parameters:

Parameter

Type

Required

Description

ids

array

false

删除数据集合,[array of int64]@since

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

└─any object

object

any object.

time

string

响应时间

Response-example:

{
  "code": 771,
  "msg": "dj91jz",
  "errorMsg": "u7d6fl",
  "success": true,
  "errorNo": "tadmdl",
  "data": {},
  "time": "2023-02-13 08:31:52"
}

Curl-example:

curl -X DELETE -H 'Content-Type: application/json' -H 'Authorization' -i http://127.0.0.1:9010/com.elitesland.yst.system/sysUserProxy/batchOpen?openFlag=9 --data '[]&9'

3.22.

3.22.1.

URL: http://127.0.0.1:9010/sys/data/roles/paging

Type: POST

Author: Chris

Content-Type: application/json

Description:

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Body-parameters:

Parameter

Type

Required

Description

current

int32

false

页码

size

int32

false

页大小

keyword

string

false

搜索关键字

orders

array

false

排序

└─column

string

false

属性名称

└─asc

boolean

false

是否升序

code

string

false

角色代码

name

string

false

角色名称

enabled

boolean

false

是否启用

Request-body:

{
  "current": 608,
  "size": 10,
  "keyword": "6ztprw",
  "orders": [
    {
      "column": "820544",
      "asc": true
    }
  ],
  "code": "99507",
  "name": "marg.collier",
  "enabled": true
}

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

└─total

int64

总记录数

└─records

array

数据列表

└─id

int64

数据角色ID

└─code

string

角色代码

└─name

string

角色名称

└─enabled

boolean

是否启用

└─remark

string

备注

time

string

响应时间

Response-example:

{
  "code": 961,
  "msg": "azki2a",
  "errorMsg": "mcl4fe",
  "success": true,
  "errorNo": "g54wws",
  "data": {
    "total": 952,
    "records": [
      {
        "id": 768,
        "code": "99507",
        "name": "marg.collier",
        "enabled": true,
        "remark": "33e7o8"
      }
    ]
  },
  "time": "2023-02-13 08:31:52"
}

Curl-example:

curl -X POST -H 'Content-Type: application/json' -H 'Authorization' -i http://127.0.0.1:9010/sys/data/roles/paging --data '{
  "current": 608,
  "size": 10,
  "keyword": "6ztprw",
  "orders": [
    {
      "column": "820544",
      "asc": true
    }
  ],
  "code": "99507",
  "name": "marg.collier",
  "enabled": true
}'

3.22.2.

URL: http://127.0.0.1:9010/sys/data/roles/details/{id}

Type: GET

Author: Chris

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description:

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Path-parameters:

Parameter

Value

Type

Required

Description

int64

true

No comments found.

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

└─id

int64

数据角色ID

└─code

string

角色代码

└─name

string

角色名称

└─enabled

boolean

是否启用

└─advancedEnable

boolean

是否启用高级授权

└─businessEnable

boolean

是否启用业务授权

└─remark

string

备注

└─sysDataRoleBasicAuth

object

基础授权信息

└─id

int64

└─isBasic

boolean

是否基础数据授权：true 是，false 否

└─isPermitAll

boolean

是否全部授权全部数据

└─permissionId

int64

高级授权应用ID

└─permissionCode

string

高级授权应用编号

└─empAuthEnable

boolean

是否启用员工授权

└─empAuthScope

string

员工数据权限授权范围

└─empCustomizeEnable

boolean

员工是否启用自定义授权

└─empCustomize

array

自定义员工列表

└─dataRoleAuthId

int64

数据角色授权信息ID

└─customizeType

string

自定义类型：人员还是组织

└─secId

int64

自定义授权数据ID

└─secCode

string

自定义授权数据CODE

└─secName

string

自定义授权数据名称

└─buAuthEnable

boolean

是否启用组织授权

└─buAuthScope

string

组织数据权限授权范围

└─buCustomizeEnable

boolean

组织是否启用自定义授权

└─buCustomize

array

自定义组织列表

└─dataRoleAuthId

int64

数据角色授权信息ID

└─customizeType

string

自定义类型：人员还是组织

└─secId

int64

自定义授权数据ID

└─secCode

string

自定义授权数据CODE

└─secName

string

自定义授权数据名称

└─ouAuthEnable

boolean

是否启用组织授权

└─ouCustomizeEnable

boolean

公司是否启用自定义授权

└─ouCustomize

array

自定义公司列表

└─dataRoleAuthId

int64

数据角色授权信息ID

└─customizeType

string

自定义类型：人员还是组织

└─secId

int64

自定义授权数据ID

└─secCode

string

自定义授权数据CODE

└─secName

string

自定义授权数据名称

└─sysDataRoleAdvancedAuth

array

高级授权信息

└─id

int64

└─isBasic

boolean

是否基础数据授权：true 是，false 否

└─isPermitAll

boolean

是否全部授权全部数据

└─permissionId

int64

高级授权应用ID

└─permissionCode

string

高级授权应用编号

└─empAuthEnable

boolean

是否启用员工授权

└─empAuthScope

string

员工数据权限授权范围

└─empCustomizeEnable

boolean

员工是否启用自定义授权

└─empCustomize

array

自定义员工列表

└─dataRoleAuthId

int64

数据角色授权信息ID

└─customizeType

string

自定义类型：人员还是组织

└─secId

int64

自定义授权数据ID

└─secCode

string

自定义授权数据CODE

└─secName

string

自定义授权数据名称

└─buAuthEnable

boolean

是否启用组织授权

└─buAuthScope

string

组织数据权限授权范围

└─buCustomizeEnable

boolean

组织是否启用自定义授权

└─buCustomize

array

自定义组织列表

└─dataRoleAuthId

int64

数据角色授权信息ID

└─customizeType

string

自定义类型：人员还是组织

└─secId

int64

自定义授权数据ID

└─secCode

string

自定义授权数据CODE

└─secName

string

自定义授权数据名称

└─ouAuthEnable

boolean

是否启用组织授权

└─ouCustomizeEnable

boolean

公司是否启用自定义授权

└─ouCustomize

array

自定义公司列表

└─dataRoleAuthId

int64

数据角色授权信息ID

└─customizeType

string

自定义类型：人员还是组织

└─secId

int64

自定义授权数据ID

└─secCode

string

自定义授权数据CODE

└─secName

string

自定义授权数据名称

└─sysBizDataConstraintVOS

array

No comments found.

└─metaColumnId

int64

No comments found.

└─dataRoleCode

string

No comments found.

└─dataRoleName

string

No comments found.

└─domainCode

string

No comments found.

└─domainName

string

No comments found.

└─tableCode

string

No comments found.

└─tableName

string

No comments found.

└─fieldCode

string

No comments found.

└─fieldCaption

string

No comments found.

└─fieldType

string

No comments found.

└─fieldUdcType

string

No comments found.

└─udcDomainCode

string

No comments found.

└─udcCode

string

No comments found.

└─defaultValue

string

No comments found.

└─compareOpCode

string

No comments found.

└─compareOpName

string

No comments found.

└─constraintValues

string

No comments found.

time

string

响应时间

Response-example:

{
  "code": 251,
  "msg": "9l17in",
  "errorMsg": "tw2tqk",
  "success": true,
  "errorNo": "82sk1a",
  "data": {
    "id": 517,
    "code": "99507",
    "name": "marg.collier",
    "enabled": true,
    "advancedEnable": true,
    "businessEnable": true,
    "remark": "b60hbj",
    "sysDataRoleBasicAuth": {
      "id": 829,
      "isBasic": true,
      "isPermitAll": true,
      "permissionId": 412,
      "permissionCode": "99507",
      "empAuthEnable": true,
      "empAuthScope": "bnaket",
      "empCustomizeEnable": true,
      "empCustomize": [
        {
          "dataRoleAuthId": 847,
          "customizeType": "2mnslg",
          "secId": 152,
          "secCode": "99507",
          "secName": "marg.collier"
        }
      ],
      "buAuthEnable": true,
      "buAuthScope": "bn8ysw",
      "buCustomizeEnable": true,
      "buCustomize": [
        {
          "dataRoleAuthId": 687,
          "customizeType": "7qa9lv",
          "secId": 6,
          "secCode": "99507",
          "secName": "marg.collier"
        }
      ],
      "ouAuthEnable": true,
      "ouCustomizeEnable": true,
      "ouCustomize": [
        {
          "dataRoleAuthId": 246,
          "customizeType": "wdnjxq",
          "secId": 368,
          "secCode": "99507",
          "secName": "marg.collier"
        }
      ]
    },
    "sysDataRoleAdvancedAuth": [
      {
        "id": 7,
        "isBasic": true,
        "isPermitAll": true,
        "permissionId": 76,
        "permissionCode": "99507",
        "empAuthEnable": true,
        "empAuthScope": "dwyl68",
        "empCustomizeEnable": true,
        "empCustomize": [
          {
            "dataRoleAuthId": 313,
            "customizeType": "oh1d8g",
            "secId": 534,
            "secCode": "99507",
            "secName": "marg.collier"
          }
        ],
        "buAuthEnable": true,
        "buAuthScope": "2lrwbe",
        "buCustomizeEnable": true,
        "buCustomize": [
          {
            "dataRoleAuthId": 711,
            "customizeType": "8gypr7",
            "secId": 816,
            "secCode": "99507",
            "secName": "marg.collier"
          }
        ],
        "ouAuthEnable": true,
        "ouCustomizeEnable": true,
        "ouCustomize": [
          {
            "dataRoleAuthId": 464,
            "customizeType": "5k9tub",
            "secId": 625,
            "secCode": "99507",
            "secName": "marg.collier"
          }
        ]
      }
    ],
    "sysBizDataConstraintVOS": [
      {
        "metaColumnId": 722,
        "dataRoleCode": "99507",
        "dataRoleName": "marg.collier",
        "domainCode": "99507",
        "domainName": "marg.collier",
        "tableCode": "99507",
        "tableName": "marg.collier",
        "fieldCode": "99507",
        "fieldCaption": "imm9td",
        "fieldType": "kl8syb",
        "fieldUdcType": "vpds5c",
        "udcDomainCode": "99507",
        "udcCode": "99507",
        "defaultValue": "98nwm9",
        "compareOpCode": "99507",
        "compareOpName": "marg.collier",
        "constraintValues": "6ruh1p"
      }
    ]
  },
  "time": "2023-02-13 08:31:52"
}

Curl-example:

curl -X GET -H 'Authorization' -i http://127.0.0.1:9010/sys/data/roles/details/491

3.22.3.

URL: http://127.0.0.1:9010/sys/data/roles/save

Type: POST

Author: Chris

Content-Type: application/json

Description:

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Body-parameters:

Parameter

Type

Required

Description

int64

false

数据角色ID

code

string

true

数据角色代码

name

string

true

数据角色名称

enabled

boolean

true

是否启用

advancedEnable

boolean

true

是否启用高级授权

businessEnable

boolean

true

No comments found.

remark

string

false

备注

sysDataRoleBasicAuth

object

true

基础授权信息

└─id

int64

false

└─isBasic

boolean

false

是否基础数据授权：true 是，false 否

└─isPermitAll

boolean

false

是否全部授权全部数据

└─permissionId

int64

false

高级授权应用ID

└─permissionCode

string

false

高级授权应用编号

└─empAuthEnable

boolean

false

是否启用员工授权

└─empAuthScope

string

false

员工数据权限授权范围

└─empCustomizeEnable

boolean

false

员工是否启用自定义授权

└─empCustomize

array

false

自定义员工列表

└─dataRoleAuthId

int64

false

数据角色授权信息ID

└─customizeType

string

false

自定义类型：人员还是组织

└─secId

int64

false

自定义授权数据ID

└─secCode

string

false

自定义授权数据CODE

└─secName

string

false

自定义授权数据名称

└─buAuthEnable

boolean

false

是否启用组织授权

└─buAuthScope

string

false

组织数据权限授权范围

└─buCustomizeEnable

boolean

false

组织是否启用自定义授权

└─buCustomize

array

false

自定义组织列表

└─dataRoleAuthId

int64

false

数据角色授权信息ID

└─customizeType

string

false

自定义类型：人员还是组织

└─secId

int64

false

自定义授权数据ID

└─secCode

string

false

自定义授权数据CODE

└─secName

string

false

自定义授权数据名称

└─ouAuthEnable

boolean

false

是否启用组织授权

└─ouCustomizeEnable

boolean

false

公司是否启用自定义授权

└─ouCustomize

array

false

自定义公司列表

└─dataRoleAuthId

int64

false

数据角色授权信息ID

└─customizeType

string

false

自定义类型：人员还是组织

└─secId

int64

false

自定义授权数据ID

└─secCode

string

false

自定义授权数据CODE

└─secName

string

false

自定义授权数据名称

sysDataRoleAdvancedAuth

array

false

高级授权信息

└─id

int64

false

└─isBasic

boolean

false

是否基础数据授权：true 是，false 否

└─isPermitAll

boolean

false

是否全部授权全部数据

└─permissionId

int64

false

高级授权应用ID

└─permissionCode

string

false

高级授权应用编号

└─empAuthEnable

boolean

false

是否启用员工授权

└─empAuthScope

string

false

员工数据权限授权范围

└─empCustomizeEnable

boolean

false

员工是否启用自定义授权

└─empCustomize

array

false

自定义员工列表

└─dataRoleAuthId

int64

false

数据角色授权信息ID

└─customizeType

string

false

自定义类型：人员还是组织

└─secId

int64

false

自定义授权数据ID

└─secCode

string

false

自定义授权数据CODE

└─secName

string

false

自定义授权数据名称

└─buAuthEnable

boolean

false

是否启用组织授权

└─buAuthScope

string

false

组织数据权限授权范围

└─buCustomizeEnable

boolean

false

组织是否启用自定义授权

└─buCustomize

array

false

自定义组织列表

└─dataRoleAuthId

int64

false

数据角色授权信息ID

└─customizeType

string

false

自定义类型：人员还是组织

└─secId

int64

false

自定义授权数据ID

└─secCode

string

false

自定义授权数据CODE

└─secName

string

false

自定义授权数据名称

└─ouAuthEnable

boolean

false

是否启用组织授权

└─ouCustomizeEnable

boolean

false

公司是否启用自定义授权

└─ouCustomize

array

false

自定义公司列表

└─dataRoleAuthId

int64

false

数据角色授权信息ID

└─customizeType

string

false

自定义类型：人员还是组织

└─secId

int64

false

自定义授权数据ID

└─secCode

string

false

自定义授权数据CODE

└─secName

string

false

自定义授权数据名称

sysBizDataConstraintSaveParams

array

false

No comments found.

└─metaColumnId

int64

false

No comments found.

└─compareOpCode

string

false

No comments found.

└─compareOpName

string

false

No comments found.

└─constraintValues

string

false

No comments found.

Request-body:

{
  "id": 229,
  "code": "99507",
  "name": "marg.collier",
  "enabled": true,
  "advancedEnable": true,
  "businessEnable": true,
  "remark": "2rflka",
  "sysDataRoleBasicAuth": {
    "id": 484,
    "isBasic": true,
    "isPermitAll": true,
    "permissionId": 699,
    "permissionCode": "99507",
    "empAuthEnable": true,
    "empAuthScope": "5oqmx2",
    "empCustomizeEnable": true,
    "empCustomize": [
      {
        "dataRoleAuthId": 165,
        "customizeType": "6khfc6",
        "secId": 130,
        "secCode": "99507",
        "secName": "marg.collier"
      }
    ],
    "buAuthEnable": true,
    "buAuthScope": "k0ztrw",
    "buCustomizeEnable": true,
    "buCustomize": [
      {
        "dataRoleAuthId": 966,
        "customizeType": "q3qt8h",
        "secId": 960,
        "secCode": "99507",
        "secName": "marg.collier"
      }
    ],
    "ouAuthEnable": true,
    "ouCustomizeEnable": true,
    "ouCustomize": [
      {
        "dataRoleAuthId": 274,
        "customizeType": "n9by2j",
        "secId": 744,
        "secCode": "99507",
        "secName": "marg.collier"
      }
    ]
  },
  "sysDataRoleAdvancedAuth": [
    {
      "id": 104,
      "isBasic": true,
      "isPermitAll": true,
      "permissionId": 677,
      "permissionCode": "99507",
      "empAuthEnable": true,
      "empAuthScope": "jefyvw",
      "empCustomizeEnable": true,
      "empCustomize": [
        {
          "dataRoleAuthId": 558,
          "customizeType": "pgzbvd",
          "secId": 23,
          "secCode": "99507",
          "secName": "marg.collier"
        }
      ],
      "buAuthEnable": true,
      "buAuthScope": "hjckue",
      "buCustomizeEnable": true,
      "buCustomize": [
        {
          "dataRoleAuthId": 559,
          "customizeType": "30yklf",
          "secId": 503,
          "secCode": "99507",
          "secName": "marg.collier"
        }
      ],
      "ouAuthEnable": true,
      "ouCustomizeEnable": true,
      "ouCustomize": [
        {
          "dataRoleAuthId": 345,
          "customizeType": "gg1uvj",
          "secId": 271,
          "secCode": "99507",
          "secName": "marg.collier"
        }
      ]
    }
  ],
  "sysBizDataConstraintSaveParams": [
    {
      "metaColumnId": 346,
      "compareOpCode": "99507",
      "compareOpName": "marg.collier",
      "constraintValues": "n723sg"
    }
  ]
}

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

string

响应数据

time

string

响应时间

Response-example:

{
  "code": 843,
  "msg": "sgx0c1",
  "errorMsg": "sk3c85",
  "success": true,
  "errorNo": "gnya9m",
  "data": "k1eqt0",
  "time": "2023-02-13 08:31:52"
}

Curl-example:

curl -X POST -H 'Content-Type: application/json' -H 'Authorization' -i http://127.0.0.1:9010/sys/data/roles/save --data '{
  "id": 229,
  "code": "99507",
  "name": "marg.collier",
  "enabled": true,
  "advancedEnable": true,
  "businessEnable": true,
  "remark": "2rflka",
  "sysDataRoleBasicAuth": {
    "id": 484,
    "isBasic": true,
    "isPermitAll": true,
    "permissionId": 699,
    "permissionCode": "99507",
    "empAuthEnable": true,
    "empAuthScope": "5oqmx2",
    "empCustomizeEnable": true,
    "empCustomize": [
      {
        "dataRoleAuthId": 165,
        "customizeType": "6khfc6",
        "secId": 130,
        "secCode": "99507",
        "secName": "marg.collier"
      }
    ],
    "buAuthEnable": true,
    "buAuthScope": "k0ztrw",
    "buCustomizeEnable": true,
    "buCustomize": [
      {
        "dataRoleAuthId": 966,
        "customizeType": "q3qt8h",
        "secId": 960,
        "secCode": "99507",
        "secName": "marg.collier"
      }
    ],
    "ouAuthEnable": true,
    "ouCustomizeEnable": true,
    "ouCustomize": [
      {
        "dataRoleAuthId": 274,
        "customizeType": "n9by2j",
        "secId": 744,
        "secCode": "99507",
        "secName": "marg.collier"
      }
    ]
  },
  "sysDataRoleAdvancedAuth": [
    {
      "id": 104,
      "isBasic": true,
      "isPermitAll": true,
      "permissionId": 677,
      "permissionCode": "99507",
      "empAuthEnable": true,
      "empAuthScope": "jefyvw",
      "empCustomizeEnable": true,
      "empCustomize": [
        {
          "dataRoleAuthId": 558,
          "customizeType": "pgzbvd",
          "secId": 23,
          "secCode": "99507",
          "secName": "marg.collier"
        }
      ],
      "buAuthEnable": true,
      "buAuthScope": "hjckue",
      "buCustomizeEnable": true,
      "buCustomize": [
        {
          "dataRoleAuthId": 559,
          "customizeType": "30yklf",
          "secId": 503,
          "secCode": "99507",
          "secName": "marg.collier"
        }
      ],
      "ouAuthEnable": true,
      "ouCustomizeEnable": true,
      "ouCustomize": [
        {
          "dataRoleAuthId": 345,
          "customizeType": "gg1uvj",
          "secId": 271,
          "secCode": "99507",
          "secName": "marg.collier"
        }
      ]
    }
  ],
  "sysBizDataConstraintSaveParams": [
    {
      "metaColumnId": 346,
      "compareOpCode": "99507",
      "compareOpName": "marg.collier",
      "constraintValues": "n723sg"
    }
  ]
}'

3.22.4.

URL: http://127.0.0.1:9010/sys/data/roles/select

Type: GET

Author: Chris

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description:

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

array

响应数据

└─id

int64

记录唯一ID

└─code

string

数据角色代码

└─name

string

数据角色名称

└─enabled

boolean

是否启用

└─noPermission

boolean

操作人是否有对应的权限

time

string

响应时间

Response-example:

{
  "code": 612,
  "msg": "o9bdj1",
  "errorMsg": "s4zm8k",
  "success": true,
  "errorNo": "d5t4s6",
  "data": [
    {
      "id": 686,
      "code": "99507",
      "name": "marg.collier",
      "enabled": true,
      "noPermission": true
    }
  ],
  "time": "2023-02-13 08:31:52"
}

Curl-example:

curl -X GET -H 'Authorization' -i http://127.0.0.1:9010/sys/data/roles/select

3.22.5.

URL: http://127.0.0.1:9010/sys/data/roles/status/switch/batch

Type: POST

Author: Chris

Content-Type: application/json

Description:

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Body-parameters:

Parameter

Type

Required

Description

ids

array

false

角色ID列表

enabled

boolean

false

需要切换的状态

Request-body:

{
  "ids": [
    444
  ],
  "enabled": true
}

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

└─any object

object

any object.

time

string

响应时间

Response-example:

{
  "code": 337,
  "msg": "x1zp26",
  "errorMsg": "zw5f9r",
  "success": true,
  "errorNo": "zaxnwt",
  "data": {},
  "time": "2023-02-13 08:31:52"
}

Curl-example:

curl -X POST -H 'Content-Type: application/json' -H 'Authorization' -i http://127.0.0.1:9010/sys/data/roles/status/switch/batch --data '{
  "ids": [
    444
  ],
  "enabled": true
}'

3.23.

3.23.1.

URL: http://127.0.0.1:9010/sys/flow/roles/paging

Type: POST

Author: Chris

Content-Type: application/json

Description:

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Body-parameters:

Parameter

Type

Required

Description

current

int32

false

页码

size

int32

false

页大小

keyword

string

false

搜索关键字

orders

array

false

排序

└─column

string

false

属性名称

└─asc

boolean

false

是否升序

code

string

false

No comments found.

name

string

false

No comments found.

enable

boolean

false

No comments found.

Request-body:

{
  "current": 363,
  "size": 10,
  "keyword": "lx2xi9",
  "orders": [
    {
      "column": "8f6znp",
      "asc": true
    }
  ],
  "code": "99507",
  "name": "marg.collier",
  "enable": true
}

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

└─total

int64

总记录数

└─records

array

数据列表

└─id

int64

No comments found.

└─code

string

No comments found.

└─name

string

No comments found.

└─enabled

boolean

No comments found.

time

string

响应时间

Response-example:

{
  "code": 672,
  "msg": "bdk580",
  "errorMsg": "yol8vm",
  "success": true,
  "errorNo": "669qzy",
  "data": {
    "total": 90,
    "records": [
      {
        "id": 87,
        "code": "99507",
        "name": "marg.collier",
        "enabled": true
      }
    ]
  },
  "time": "2023-02-13 08:31:52"
}

Curl-example:

curl -X POST -H 'Content-Type: application/json' -H 'Authorization' -i http://127.0.0.1:9010/sys/flow/roles/paging --data '{
  "current": 363,
  "size": 10,
  "keyword": "lx2xi9",
  "orders": [
    {
      "column": "8f6znp",
      "asc": true
    }
  ],
  "code": "99507",
  "name": "marg.collier",
  "enable": true
}'

3.23.2.

URL: http://127.0.0.1:9010/sys/flow/roles/details/{id}

Type: GET

Author: Chris

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description:

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Path-parameters:

Parameter

Value

Type

Required

Description

int64

true

No comments found.

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

└─id

int64

No comments found.

└─code

string

No comments found.

└─name

string

No comments found.

└─enabled

boolean

No comments found.

time

string

响应时间

Response-example:

{
  "code": 176,
  "msg": "tsyi1b",
  "errorMsg": "1tt2ar",
  "success": true,
  "errorNo": "i6x7y8",
  "data": {
    "id": 409,
    "code": "99507",
    "name": "marg.collier",
    "enabled": true
  },
  "time": "2023-02-13 08:31:52"
}

Curl-example:

curl -X GET -H 'Authorization' -i http://127.0.0.1:9010/sys/flow/roles/details/73

3.23.3.

URL: http://127.0.0.1:9010/sys/flow/roles/save

Type: POST

Author: Chris

Content-Type: application/json

Description:

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Body-parameters:

Parameter

Type

Required

Description

int64

false

No comments found.

code

string

false

No comments found.

name

string

false

No comments found.

enabled

boolean

false

No comments found.

Request-body:

{
  "id": 465,
  "code": "99507",
  "name": "marg.collier",
  "enabled": true
}

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

string

响应数据

time

string

响应时间

Response-example:

{
  "code": 224,
  "msg": "hatvd8",
  "errorMsg": "2ss83u",
  "success": true,
  "errorNo": "j68q3h",
  "data": "1aixdh",
  "time": "2023-02-13 08:31:52"
}

Curl-example:

curl -X POST -H 'Content-Type: application/json' -H 'Authorization' -i http://127.0.0.1:9010/sys/flow/roles/save --data '{
  "id": 465,
  "code": "99507",
  "name": "marg.collier",
  "enabled": true
}'

3.23.4.

URL: http://127.0.0.1:9010/sys/flow/roles/select

Type: GET

Author: Chris

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description:

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

array

响应数据

└─id

int64

No comments found.

└─code

string

No comments found.

└─name

string

No comments found.

└─enabled

boolean

No comments found.

└─noPermission

boolean

操作人是否有对应的权限

time

string

响应时间

Response-example:

{
  "code": 503,
  "msg": "up2nmq",
  "errorMsg": "odjjrg",
  "success": true,
  "errorNo": "bcvhs0",
  "data": [
    {
      "id": 657,
      "code": "99507",
      "name": "marg.collier",
      "enabled": true,
      "noPermission": true
    }
  ],
  "time": "2023-02-13 08:31:52"
}

Curl-example:

curl -X GET -H 'Authorization' -i http://127.0.0.1:9010/sys/flow/roles/select

3.23.5.

URL: http://127.0.0.1:9010/sys/flow/roles/status/switch/batch

Type: POST

Author: Chris

Content-Type: application/json

Description:

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Body-parameters:

Parameter

Type

Required

Description

ids

array

false

角色ID列表

enabled

boolean

false

需要切换的状态

Request-body:

{
  "ids": [
    304
  ],
  "enabled": true
}

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

└─any object

object

any object.

time

string

响应时间

Response-example:

{
  "code": 390,
  "msg": "p4i4fi",
  "errorMsg": "mvuy0e",
  "success": true,
  "errorNo": "wuyns7",
  "data": {},
  "time": "2023-02-13 08:31:52"
}

Curl-example:

curl -X POST -H 'Content-Type: application/json' -H 'Authorization' -i http://127.0.0.1:9010/sys/flow/roles/status/switch/batch --data '{
  "ids": [
    304
  ],
  "enabled": true
}'

3.24. 功能说明

3.24.1. 通过主键查询单条数据

URL: http://127.0.0.1:9010/sys/sysRoleOu/findIdOne/{id}

Type: GET

Author: roman.zhang

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 通过主键查询单条数据

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Path-parameters:

Parameter

Value

Type

Required

Description

int64

true

主键

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

└─id

int64

记录唯一ID

└─ouId

int64

公司ID

└─ouName

string

公司名称

└─roleId

int64

角色ID

└─roleName

string

角色名称

└─roleType

int32

角色类型：0：应用角色，1 数据角色目前仅支持数据角色

└─username

string

No comments found.

└─lastName

string

No comments found.

└─firstName

string

No comments found.

└─userId

int64

No comments found.

└─tenantId

int64

租户ID

└─remark

string

备注

└─createUserId

int64

记录创建者ID

└─creator

string

记录创建者

└─createTime

string

记录创建时间

└─modifyUserId

int64

记录最后更新者ID

└─updater

string

记录最后更新者

└─modifyTime

string

记录最后更新时间

└─deleteFlag

int32

逻辑删除，0：未删除，1：已删除

└─auditDataVersion

int32

锁版本

└─secBuId

int64

sec_bu_id

└─secUserId

int64

sec_user_id

└─secOuId

int64

sec_ou_id

time

string

响应时间

Response-example:

{
  "code": 737,
  "msg": "17x397",
  "errorMsg": "s45wy2",
  "success": true,
  "errorNo": "v4svyp",
  "data": {
    "id": 486,
    "ouId": 293,
    "ouName": "marg.collier",
    "roleId": 477,
    "roleName": "marg.collier",
    "roleType": 41,
    "username": "marg.collier",
    "lastName": "marg.collier",
    "firstName": "marg.collier",
    "userId": 985,
    "tenantId": 226,
    "remark": "5rruew",
    "createUserId": 138,
    "creator": "vwi6qo",
    "createTime": "2023-02-13 08:31:52",
    "modifyUserId": 864,
    "updater": "5mqd6b",
    "modifyTime": "2023-02-13 08:31:52",
    "deleteFlag": 9,
    "auditDataVersion": 872,
    "secBuId": 776,
    "secUserId": 604,
    "secOuId": 786
  },
  "time": "2023-02-13 08:31:52"
}

Curl-example:

curl -X GET -H 'Authorization' -i http://127.0.0.1:9010/sys/sysRoleOu/findIdOne/936

3.24.2. 通过主键查询单条数据

URL: http://127.0.0.1:9010/sys/sysRoleOu/selectByUserId/{id}

Type: GET

Author: roman.zhang

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 通过主键查询单条数据

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Path-parameters:

Parameter

Value

Type

Required

Description

int64

true

主键

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

array

响应数据

└─id

int64

记录唯一ID

└─ouId

int64

公司ID

└─ouName

string

公司名称

└─roleId

int64

角色ID

└─roleName

string

角色名称

└─roleType

int32

角色类型：0：应用角色，1 数据角色目前仅支持数据角色

└─username

string

No comments found.

└─lastName

string

No comments found.

└─firstName

string

No comments found.

└─userId

int64

No comments found.

└─tenantId

int64

租户ID

└─remark

string

备注

└─createUserId

int64

记录创建者ID

└─creator

string

记录创建者

└─createTime

string

记录创建时间

└─modifyUserId

int64

记录最后更新者ID

└─updater

string

记录最后更新者

└─modifyTime

string

记录最后更新时间

└─deleteFlag

int32

逻辑删除，0：未删除，1：已删除

└─auditDataVersion

int32

锁版本

└─secBuId

int64

sec_bu_id

└─secUserId

int64

sec_user_id

└─secOuId

int64

sec_ou_id

time

string

响应时间

Response-example:

{
  "code": 278,
  "msg": "7yik6v",
  "errorMsg": "znx9vh",
  "success": true,
  "errorNo": "mrtrcn",
  "data": [
    {
      "id": 400,
      "ouId": 180,
      "ouName": "marg.collier",
      "roleId": 218,
      "roleName": "marg.collier",
      "roleType": 79,
      "username": "marg.collier",
      "lastName": "marg.collier",
      "firstName": "marg.collier",
      "userId": 219,
      "tenantId": 121,
      "remark": "b349w9",
      "createUserId": 65,
      "creator": "rgahdd",
      "createTime": "2023-02-13 08:31:52",
      "modifyUserId": 447,
      "updater": "4qxeup",
      "modifyTime": "2023-02-13 08:31:52",
      "deleteFlag": 9,
      "auditDataVersion": 386,
      "secBuId": 507,
      "secUserId": 116,
      "secOuId": 522
    }
  ],
  "time": "2023-02-13 08:31:52"
}

Curl-example:

curl -X GET -H 'Authorization' -i http://127.0.0.1:9010/sys/sysRoleOu/selectByUserId/153

3.24.3. 根据关键字段查询数据

URL: http://127.0.0.1:9010/sys/sysRoleOu/findCodeOne/{key}

Type: GET

Author: roman.zhang

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据关键字段查询数据

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Path-parameters:

Parameter

Value

Type

Required

Description

key

string

true

参数

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

└─id

int64

记录唯一ID

└─ouId

int64

公司ID

└─ouName

string

公司名称

└─roleId

int64

角色ID

└─roleName

string

角色名称

└─roleType

int32

角色类型：0：应用角色，1 数据角色目前仅支持数据角色

└─username

string

No comments found.

└─lastName

string

No comments found.

└─firstName

string

No comments found.

└─userId

int64

No comments found.

└─tenantId

int64

租户ID

└─remark

string

备注

└─createUserId

int64

记录创建者ID

└─creator

string

记录创建者

└─createTime

string

记录创建时间

└─modifyUserId

int64

记录最后更新者ID

└─updater

string

记录最后更新者

└─modifyTime

string

记录最后更新时间

└─deleteFlag

int32

逻辑删除，0：未删除，1：已删除

└─auditDataVersion

int32

锁版本

└─secBuId

int64

sec_bu_id

└─secUserId

int64

sec_user_id

└─secOuId

int64

sec_ou_id

time

string

响应时间

Response-example:

{
  "code": 785,
  "msg": "hw8yvz",
  "errorMsg": "ja0nni",
  "success": true,
  "errorNo": "j67syj",
  "data": {
    "id": 319,
    "ouId": 692,
    "ouName": "marg.collier",
    "roleId": 170,
    "roleName": "marg.collier",
    "roleType": 824,
    "username": "marg.collier",
    "lastName": "marg.collier",
    "firstName": "marg.collier",
    "userId": 941,
    "tenantId": 949,
    "remark": "hyix7f",
    "createUserId": 415,
    "creator": "br66rt",
    "createTime": "2023-02-13 08:31:52",
    "modifyUserId": 412,
    "updater": "59odeg",
    "modifyTime": "2023-02-13 08:31:52",
    "deleteFlag": 9,
    "auditDataVersion": 996,
    "secBuId": 645,
    "secUserId": 452,
    "secOuId": 929
  },
  "time": "2023-02-13 08:31:52"
}

Curl-example:

curl -X GET -H 'Authorization' -i http://127.0.0.1:9010/sys/sysRoleOu/findCodeOne/iogerf

3.24.4. 分页查询

URL: http://127.0.0.1:9010/sys/sysRoleOu/search

Type: POST

Author: roman.zhang

Content-Type: application/json

Description: 分页查询

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Body-parameters:

Parameter

Type

Required

Description

current

int32

false

页码

size

int32

false

页大小

keyword

string

false

搜索关键字

orders

array

false

排序

└─column

string

false

属性名称

└─asc

boolean

false

是否升序

int64

false

记录唯一ID

ouId

int64

false

公司ID

ouName

string

false

公司名称

roleId

int64

false

角色ID

roleName

string

false

角色名称

roleType

int32

false

角色类型：0：应用角色，1 数据角色目前仅支持数据角色

username

string

false

No comments found.

lastName

string

false

No comments found.

firstName

string

false

No comments found.

userId

int64

false

No comments found.

tenantId

int64

false

租户ID

remark

string

false

备注

createUserId

int64

false

记录创建者ID

creator

string

false

记录创建者

createTime

string

false

记录创建时间

modifyUserId

int64

false

记录最后更新者ID

updater

string

false

记录最后更新者

modifyTime

string

false

记录最后更新时间

deleteFlag

int32

false

逻辑删除，0：未删除，1：已删除

auditDataVersion

int32

false

锁版本

secBuId

int64

false

sec_bu_id

secUserId

int64

false

sec_user_id

secOuId

int64

false

sec_ou_id

Request-body:

{
  "current": 774,
  "size": 10,
  "keyword": "v859q6",
  "orders": [
    {
      "column": "0w9wq5",
      "asc": true
    }
  ],
  "id": 323,
  "ouId": 25,
  "ouName": "marg.collier",
  "roleId": 893,
  "roleName": "marg.collier",
  "roleType": 922,
  "username": "marg.collier",
  "lastName": "marg.collier",
  "firstName": "marg.collier",
  "userId": 374,
  "tenantId": 932,
  "remark": "ap1u50",
  "createUserId": 260,
  "creator": "7j2sza",
  "createTime": "2023-02-13 08:31:52",
  "modifyUserId": 289,
  "updater": "v8386z",
  "modifyTime": "2023-02-13 08:31:52",
  "deleteFlag": 9,
  "auditDataVersion": 291,
  "secBuId": 383,
  "secUserId": 657,
  "secOuId": 590
}

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

└─total

int64

总记录数

└─records

array

数据列表

└─id

int64

记录唯一ID

└─ouId

int64

公司ID

└─ouName

string

公司名称

└─roleId

int64

角色ID

└─roleName

string

角色名称

└─roleType

int32

角色类型：0：应用角色，1 数据角色目前仅支持数据角色

└─username

string

No comments found.

└─lastName

string

No comments found.

└─firstName

string

No comments found.

└─userId

int64

No comments found.

└─tenantId

int64

租户ID

└─remark

string

备注

└─createUserId

int64

记录创建者ID

└─creator

string

记录创建者

└─createTime

string

记录创建时间

└─modifyUserId

int64

记录最后更新者ID

└─updater

string

记录最后更新者

└─modifyTime

string

记录最后更新时间

└─deleteFlag

int32

逻辑删除，0：未删除，1：已删除

└─auditDataVersion

int32

锁版本

└─secBuId

int64

sec_bu_id

└─secUserId

int64

sec_user_id

└─secOuId

int64

sec_ou_id

time

string

响应时间

Response-example:

{
  "code": 591,
  "msg": "f1earm",
  "errorMsg": "nw6ol3",
  "success": true,
  "errorNo": "l0otaz",
  "data": {
    "total": 90,
    "records": [
      {
        "id": 750,
        "ouId": 900,
        "ouName": "marg.collier",
        "roleId": 462,
        "roleName": "marg.collier",
        "roleType": 538,
        "username": "marg.collier",
        "lastName": "marg.collier",
        "firstName": "marg.collier",
        "userId": 764,
        "tenantId": 905,
        "remark": "edj6fl",
        "createUserId": 721,
        "creator": "lvn23g",
        "createTime": "2023-02-13 08:31:52",
        "modifyUserId": 277,
        "updater": "pcajyk",
        "modifyTime": "2023-02-13 08:31:52",
        "deleteFlag": 9,
        "auditDataVersion": 633,
        "secBuId": 684,
        "secUserId": 38,
        "secOuId": 163
      }
    ]
  },
  "time": "2023-02-13 08:31:52"
}

Curl-example:

curl -X POST -H 'Content-Type: application/json' -H 'Authorization' -i http://127.0.0.1:9010/sys/sysRoleOu/search --data '{
  "current": 774,
  "size": 10,
  "keyword": "v859q6",
  "orders": [
    {
      "column": "0w9wq5",
      "asc": true
    }
  ],
  "id": 323,
  "ouId": 25,
  "ouName": "marg.collier",
  "roleId": 893,
  "roleName": "marg.collier",
  "roleType": 922,
  "username": "marg.collier",
  "lastName": "marg.collier",
  "firstName": "marg.collier",
  "userId": 374,
  "tenantId": 932,
  "remark": "ap1u50",
  "createUserId": 260,
  "creator": "7j2sza",
  "createTime": "2023-02-13 08:31:52",
  "modifyUserId": 289,
  "updater": "v8386z",
  "modifyTime": "2023-02-13 08:31:52",
  "deleteFlag": 9,
  "auditDataVersion": 291,
  "secBuId": 383,
  "secUserId": 657,
  "secOuId": 590
}'

3.24.5. 新增数据

URL: http://127.0.0.1:9010/sys/sysRoleOu/createOne

Type: POST

Author: roman.zhang

Content-Type: application/json

Description: 新增数据

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Body-parameters:

Parameter

Type

Required

Description

int64

false

记录唯一ID

ouId

int64

false

公司ID

ouName

string

false

公司名称

roleId

int64

false

角色ID

roleName

string

false

角色名称

roleType

int32

false

角色类型：0：应用角色，1 数据角色目前仅支持数据角色

username

string

false

No comments found.

lastName

string

false

No comments found.

firstName

string

false

No comments found.

userId

int64

false

No comments found.

tenantId

int64

false

租户ID

remark

string

false

备注

createUserId

int64

false

记录创建者ID

creator

string

false

记录创建者

createTime

string

false

记录创建时间

modifyUserId

int64

false

记录最后更新者ID

updater

string

false

记录最后更新者

modifyTime

string

false

记录最后更新时间

deleteFlag

int32

false

逻辑删除，0：未删除，1：已删除

auditDataVersion

int32

false

锁版本

secBuId

int64

false

sec_bu_id

secUserId

int64

false

sec_user_id

secOuId

int64

false

sec_ou_id

Request-body:

{
  "id": 527,
  "ouId": 182,
  "ouName": "marg.collier",
  "roleId": 31,
  "roleName": "marg.collier",
  "roleType": 998,
  "username": "marg.collier",
  "lastName": "marg.collier",
  "firstName": "marg.collier",
  "userId": 308,
  "tenantId": 790,
  "remark": "w0o00b",
  "createUserId": 352,
  "creator": "rhy1vq",
  "createTime": "2023-02-13 08:31:53",
  "modifyUserId": 267,
  "updater": "xed1ob",
  "modifyTime": "2023-02-13 08:31:53",
  "deleteFlag": 9,
  "auditDataVersion": 440,
  "secBuId": 578,
  "secUserId": 254,
  "secOuId": 367
}

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

└─any object

object

any object.

time

string

响应时间

Response-example:

{
  "code": 865,
  "msg": "oy6k3h",
  "errorMsg": "2wxevs",
  "success": true,
  "errorNo": "su1j45",
  "data": {},
  "time": "2023-02-13 08:31:53"
}

Curl-example:

curl -X POST -H 'Content-Type: application/json' -H 'Authorization' -i http://127.0.0.1:9010/sys/sysRoleOu/createOne --data '{
  "id": 527,
  "ouId": 182,
  "ouName": "marg.collier",
  "roleId": 31,
  "roleName": "marg.collier",
  "roleType": 998,
  "username": "marg.collier",
  "lastName": "marg.collier",
  "firstName": "marg.collier",
  "userId": 308,
  "tenantId": 790,
  "remark": "w0o00b",
  "createUserId": 352,
  "creator": "rhy1vq",
  "createTime": "2023-02-13 08:31:53",
  "modifyUserId": 267,
  "updater": "xed1ob",
  "modifyTime": "2023-02-13 08:31:53",
  "deleteFlag": 9,
  "auditDataVersion": 440,
  "secBuId": 578,
  "secUserId": 254,
  "secOuId": 367
}'

3.24.6. 批量新增数据

URL: http://127.0.0.1:9010/sys/sysRoleOu/createBatch

Type: POST

Author: roman.zhang

Content-Type: application/json

Description: 批量新增数据

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Body-parameters:

Parameter

Type

Required

Description

int64

false

记录唯一ID

ouId

int64

false

公司ID

ouName

string

false

公司名称

roleId

int64

false

角色ID

roleName

string

false

角色名称

roleType

int32

false

角色类型：0：应用角色，1 数据角色目前仅支持数据角色

username

string

false

No comments found.

lastName

string

false

No comments found.

firstName

string

false

No comments found.

userId

int64

false

No comments found.

tenantId

int64

false

租户ID

remark

string

false

备注

createUserId

int64

false

记录创建者ID

creator

string

false

记录创建者

createTime

string

false

记录创建时间

modifyUserId

int64

false

记录最后更新者ID

updater

string

false

记录最后更新者

modifyTime

string

false

记录最后更新时间

deleteFlag

int32

false

逻辑删除，0：未删除，1：已删除

auditDataVersion

int32

false

锁版本

secBuId

int64

false

sec_bu_id

secUserId

int64

false

sec_user_id

secOuId

int64

false

sec_ou_id

Request-body:

[
  {
    "id": 347,
    "ouId": 741,
    "ouName": "marg.collier",
    "roleId": 339,
    "roleName": "marg.collier",
    "roleType": 599,
    "username": "marg.collier",
    "lastName": "marg.collier",
    "firstName": "marg.collier",
    "userId": 26,
    "tenantId": 575,
    "remark": "mq20vn",
    "createUserId": 814,
    "creator": "apu11j",
    "createTime": "2023-02-13 08:31:53",
    "modifyUserId": 226,
    "updater": "3gg9wh",
    "modifyTime": "2023-02-13 08:31:53",
    "deleteFlag": 9,
    "auditDataVersion": 574,
    "secBuId": 682,
    "secUserId": 675,
    "secOuId": 621
  }
]

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

└─any object

object

any object.

time

string

响应时间

Response-example:

{
  "code": 753,
  "msg": "il4htp",
  "errorMsg": "5p0vvx",
  "success": true,
  "errorNo": "o1xqf4",
  "data": {},
  "time": "2023-02-13 08:31:53"
}

Curl-example:

curl -X POST -H 'Content-Type: application/json' -H 'Authorization' -i http://127.0.0.1:9010/sys/sysRoleOu/createBatch --data '[
  {
    "id": 347,
    "ouId": 741,
    "ouName": "marg.collier",
    "roleId": 339,
    "roleName": "marg.collier",
    "roleType": 599,
    "username": "marg.collier",
    "lastName": "marg.collier",
    "firstName": "marg.collier",
    "userId": 26,
    "tenantId": 575,
    "remark": "mq20vn",
    "createUserId": 814,
    "creator": "apu11j",
    "createTime": "2023-02-13 08:31:53",
    "modifyUserId": 226,
    "updater": "3gg9wh",
    "modifyTime": "2023-02-13 08:31:53",
    "deleteFlag": 9,
    "auditDataVersion": 574,
    "secBuId": 682,
    "secUserId": 675,
    "secOuId": 621
  }
]'

3.24.7. 修改数据

URL: http://127.0.0.1:9010/sys/sysRoleOu/update

Type: PUT

Author: roman.zhang

Content-Type: application/json

Description: 修改数据

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Body-parameters:

Parameter

Type

Required

Description

int64

false

记录唯一ID

ouId

int64

false

公司ID

ouName

string

false

公司名称

roleId

int64

false

角色ID

roleName

string

false

角色名称

roleType

int32

false

角色类型：0：应用角色，1 数据角色目前仅支持数据角色

username

string

false

No comments found.

lastName

string

false

No comments found.

firstName

string

false

No comments found.

userId

int64

false

No comments found.

Request-body:

{
  "id": 217,
  "ouId": 902,
  "ouName": "marg.collier",
  "roleId": 410,
  "roleName": "marg.collier",
  "roleType": 721,
  "username": "marg.collier",
  "lastName": "marg.collier",
  "firstName": "marg.collier",
  "userId": 420
}

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

└─any object

object

any object.

time

string

响应时间

Response-example:

{
  "code": 470,
  "msg": "hjix7z",
  "errorMsg": "smivug",
  "success": true,
  "errorNo": "qykerg",
  "data": {},
  "time": "2023-02-13 08:31:53"
}

Curl-example:

curl -X PUT -H 'Content-Type: application/json' -H 'Authorization' -i http://127.0.0.1:9010/sys/sysRoleOu/update --data '{
  "id": 217,
  "ouId": 902,
  "ouName": "marg.collier",
  "roleId": 410,
  "roleName": "marg.collier",
  "roleType": 721,
  "username": "marg.collier",
  "lastName": "marg.collier",
  "firstName": "marg.collier",
  "userId": 420
}'

3.24.8. 根据主键删除数据

URL: http://127.0.0.1:9010/sys/sysRoleOu/deleteOne/{id}

Type: DELETE

Author: roman.zhang

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据主键删除数据

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Path-parameters:

Parameter

Value

Type

Required

Description

int64

true

主键

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

└─any object

object

any object.

time

string

响应时间

Response-example:

{
  "code": 783,
  "msg": "t8i7re",
  "errorMsg": "zvcnrw",
  "success": true,
  "errorNo": "i12v06",
  "data": {},
  "time": "2023-02-13 08:31:53"
}

Curl-example:

curl -X DELETE -H 'Authorization' -i http://127.0.0.1:9010/sys/sysRoleOu/deleteOne/37

3.24.9. 批量删除

URL: http://127.0.0.1:9010/sys/sysRoleOu/deleteBatch

Type: DELETE

Author: roman.zhang

Content-Type: application/json

Description: 批量删除

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Body-parameters:

Parameter

Type

Required

Description

ids

array

false

删除数据集合,[array of int64]@since

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

└─any object

object

any object.

time

string

响应时间

Response-example:

{
  "code": 374,
  "msg": "8hq2kp",
  "errorMsg": "rufu67",
  "success": true,
  "errorNo": "c6i7r6",
  "data": {},
  "time": "2023-02-13 08:31:53"
}

Curl-example:

curl -X DELETE -H 'Content-Type: application/json' -H 'Authorization' -i http://127.0.0.1:9010/sys/sysRoleOu/deleteBatch --data '[]'

3.24.10. 逻辑删除

URL: http://127.0.0.1:9010/sys/sysRoleOu/updateDeleteFlag/{id}

Type: PUT

Author: roman.zhang

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 逻辑删除

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Path-parameters:

Parameter

Value

Type

Required

Description

int64

true

更新数据

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

└─any object

object

any object.

time

string

响应时间

Response-example:

{
  "code": 255,
  "msg": "blacqd",
  "errorMsg": "qv9yn7",
  "success": true,
  "errorNo": "qfck26",
  "data": {},
  "time": "2023-02-13 08:31:53"
}

Curl-example:

curl -X PUT -H 'Authorization' -i http://127.0.0.1:9010/sys/sysRoleOu/updateDeleteFlag/684

3.25. <pre>[功能说明]</pre>

3.25.1.

URL: http://127.0.0.1:9010/sys/roles/q

Type: POST

Author: Michael Li

Content-Type: application/json

Description:

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Body-parameters:

Parameter

Type

Required

Description

current

int32

false

页码

size

int32

false

页大小

keyword

string

false

搜索关键字

orders

array

false

排序

└─column

string

false

属性名称

└─asc

boolean

false

是否升序

code

string

false

No comments found.

name

string

false

No comments found.

tenantId

int64

false

No comments found.

tenantName

string

false

No comments found.

enabled

boolean

false

No comments found.

Request-body:

{
  "current": 879,
  "size": 10,
  "keyword": "ggj51l",
  "orders": [
    {
      "column": "rwdq85",
      "asc": true
    }
  ],
  "code": "99507",
  "name": "marg.collier",
  "tenantId": 184,
  "tenantName": "marg.collier",
  "enabled": true
}

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

└─total

int64

总记录数

└─records

array

数据列表

└─id

int64

No comments found.

└─code

string

No comments found.

└─name

string

No comments found.

└─tenantId

int64

No comments found.

└─tenantName

string

No comments found.

└─enabled

boolean

No comments found.

time

string

响应时间

Response-example:

{
  "code": 718,
  "msg": "mnwe1d",
  "errorMsg": "0za5kr",
  "success": true,
  "errorNo": "xq083u",
  "data": {
    "total": 164,
    "records": [
      {
        "id": 272,
        "code": "99507",
        "name": "marg.collier",
        "tenantId": 484,
        "tenantName": "marg.collier",
        "enabled": true
      }
    ]
  },
  "time": "2023-02-13 08:31:53"
}

Curl-example:

curl -X POST -H 'Content-Type: application/json' -H 'Authorization' -i http://127.0.0.1:9010/sys/roles/q --data '{
  "current": 879,
  "size": 10,
  "keyword": "ggj51l",
  "orders": [
    {
      "column": "rwdq85",
      "asc": true
    }
  ],
  "code": "99507",
  "name": "marg.collier",
  "tenantId": 184,
  "tenantName": "marg.collier",
  "enabled": true
}'

3.25.2.

URL: http://127.0.0.1:9010/sys/roles/

Type: POST

Author: Michael Li

Content-Type: application/json

Description:

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Body-parameters:

Parameter

Type

Required

Description

code

string

false

No comments found.

name

string

false

No comments found.

tenantId

int64

false

No comments found.

tenantName

string

false

No comments found.

enabled

boolean

false

No comments found.

isQuick

boolean

false

菜单是否隐藏

terminalCode

string

false

No comments found.

permIds

array

false

No comments found.

Request-body:

{
  "code": "99507",
  "name": "marg.collier",
  "tenantId": 724,
  "tenantName": "marg.collier",
  "enabled": true,
  "isQuick": true,
  "terminalCode": "99507",
  "permIds": [
    905
  ]
}

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

string

响应数据

time

string

响应时间

Response-example:

{
  "code": 428,
  "msg": "a1tdhn",
  "errorMsg": "4b03cp",
  "success": true,
  "errorNo": "9sdzc3",
  "data": "30313h",
  "time": "2023-02-13 08:31:53"
}

Curl-example:

curl -X POST -H 'Content-Type: application/json' -H 'Authorization' -i http://127.0.0.1:9010/sys/roles/ --data '{
  "code": "99507",
  "name": "marg.collier",
  "tenantId": 724,
  "tenantName": "marg.collier",
  "enabled": true,
  "isQuick": true,
  "terminalCode": "99507",
  "permIds": [
    905
  ]
}'

3.25.3.

URL: http://127.0.0.1:9010/sys/roles/{id}

Type: GET

Author: Michael Li

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description:

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Path-parameters:

Parameter

Value

Type

Required

Description

int64

true

No comments found.

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

time

string

响应时间

Response-example:

{
  "code": 855,
  "msg": "x4qggt",
  "errorMsg": "g81lwi",
  "success": true,
  "errorNo": "11jpr7",
  "data": {},
  "time": "2023-02-13 08:31:53"
}

Curl-example:

curl -X GET -H 'Authorization' -i http://127.0.0.1:9010/sys/roles/498

3.25.4.

URL: http://127.0.0.1:9010/sys/roles/

Type: PUT

Author: Michael Li

Content-Type: application/json

Description:

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Body-parameters:

Parameter

Type

Required

Description

int64

false

No comments found.

code

string

false

No comments found.

name

string

false

No comments found.

tenantId

int64

false

No comments found.

tenantName

string

false

No comments found.

enabled

boolean

false

No comments found.

terminalCode

string

false

No comments found.

isQuick

boolean

false

菜单是否隐藏

permIds

array

false

No comments found.

Request-body:

{
  "id": 809,
  "code": "99507",
  "name": "marg.collier",
  "tenantId": 89,
  "tenantName": "marg.collier",
  "enabled": true,
  "terminalCode": "99507",
  "isQuick": true,
  "permIds": [
    916
  ]
}

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

int32

响应数据

time

string

响应时间

Response-example:

{
  "code": 160,
  "msg": "qpdbkr",
  "errorMsg": "k86a0h",
  "success": true,
  "errorNo": "sxzrd5",
  "data": 199,
  "time": "2023-02-13 08:31:53"
}

Curl-example:

curl -X PUT -H 'Content-Type: application/json' -H 'Authorization' -i http://127.0.0.1:9010/sys/roles/ --data '{
  "id": 809,
  "code": "99507",
  "name": "marg.collier",
  "tenantId": 89,
  "tenantName": "marg.collier",
  "enabled": true,
  "terminalCode": "99507",
  "isQuick": true,
  "permIds": [
    916
  ]
}'

3.25.5.

URL: http://127.0.0.1:9010/sys/roles/all

Type: GET

Author: Michael Li

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description:

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

array

响应数据

└─id

int64

No comments found.

└─code

string

No comments found.

└─name

string

No comments found.

└─tenantName

string

No comments found.

└─enabled

boolean

No comments found.

└─users

array

No comments found.

└─id

int64

记录唯一ID

└─tenantId

int64

租户ID

└─remark

string

备注

└─createUserId

int64

记录创建者ID

└─creator

string

记录创建者

└─createTime

string

记录创建时间

└─modifyUserId

int64

记录最后更新者ID

└─updater

string

记录最后更新者

└─modifyTime

string

记录最后更新时间

└─deleteFlag

int32

逻辑删除标识

└─auditDataVersion

int32

锁版本

└─username

string

No comments found.

└─lastName

string

No comments found.

└─firstName

string

No comments found.

└─mobile

string

No comments found.

└─email

string

No comments found.

└─roleNames

string

No comments found.

└─roleIds

string

No comments found.

└─wxOpenid

string

No comments found.

└─tenantName

string

No comments found.

└─enabled

boolean

No comments found.

└─roles

array

No comments found.

└─id

int64

No comments found.

└─code

string

No comments found.

└─name

string

No comments found.

└─tenantName

string

No comments found.

└─enabled

boolean

No comments found.

└─users

array

No comments found.

└─permIds

array

No comments found.

└─permissions

array

No comments found.

└─id

int64

权限ID

└─code

string

权限代码

└─name

string

权限名称

└─permType

int32

权限类型: 1.菜单；0.按钮或API调用

└─parentId

int64

父权限ID

└─parentName

string

父权限名称"

└─path

string

权限层级路径

└─permLevel

int32

权限层级

└─sortNo

int32

排列顺序

└─pattern

string

URL路径

└─httpMethod

string

URL的HTTP方法

└─isHidden

boolean

菜单是否隐藏

└─icon

string

菜单图标

└─terminalCode

string

No comments found.

└─menuDepth

int32

菜单深度

└─isQuick

boolean

菜单是否隐藏

└─noPermission

boolean

操作人是否有对应的权限

└─permissions

array

No comments found.

└─id

int64

权限ID

└─code

string

权限代码

└─name

string

权限名称

└─permType

int32

权限类型: 1.菜单；0.按钮或API调用

└─parentId

int64

父权限ID

└─parentName

string

父权限名称"

└─path

string

权限层级路径

└─permLevel

int32

权限层级

└─sortNo

int32

排列顺序

└─pattern

string

URL路径

└─httpMethod

string

URL的HTTP方法

└─isHidden

boolean

菜单是否隐藏

└─icon

string

菜单图标

└─terminalCode

string

No comments found.

└─menuDepth

int32

菜单深度

└─isQuick

boolean

菜单是否隐藏

└─permIds

array

No comments found.

└─permissions

array

No comments found.

└─id

int64

权限ID

└─code

string

权限代码

└─name

string

权限名称

└─permType

int32

权限类型: 1.菜单；0.按钮或API调用

└─parentId

int64

父权限ID

└─parentName

string

父权限名称"

└─path

string

权限层级路径

└─permLevel

int32

权限层级

└─sortNo

int32

排列顺序

└─pattern

string

URL路径

└─httpMethod

string

URL的HTTP方法

└─isHidden

boolean

菜单是否隐藏

└─icon

string

菜单图标

└─terminalCode

string

No comments found.

└─menuDepth

int32

菜单深度

└─isQuick

boolean

菜单是否隐藏

└─noPermission

boolean

操作人是否有对应的权限

time

string

响应时间

Response-example:

{
  "code": 752,
  "msg": "sb5mxa",
  "errorMsg": "dyspum",
  "success": true,
  "errorNo": "5inpr4",
  "data": [
    {
      "id": 774,
      "code": "99507",
      "name": "marg.collier",
      "tenantName": "marg.collier",
      "enabled": true,
      "users": [
        {
          "id": 247,
          "tenantId": 588,
          "remark": "o7m984",
          "createUserId": 973,
          "creator": "ox1otn",
          "createTime": "2023-02-13 08:31:53",
          "modifyUserId": 476,
          "updater": "zd5p2o",
          "modifyTime": "2023-02-13 08:31:53",
          "deleteFlag": 9,
          "auditDataVersion": 980,
          "username": "marg.collier",
          "lastName": "marg.collier",
          "firstName": "marg.collier",
          "mobile": "(734) 208-3091",
          "email": "celinda.goldner@gmail.com",
          "roleNames": "2vqwds",
          "roleIds": "s5wujz",
          "wxOpenid": "173",
          "tenantName": "marg.collier",
          "enabled": true,
          "roles": [
            {
              "id": 463,
              "code": "99507",
              "name": "marg.collier",
              "tenantName": "marg.collier",
              "enabled": true,
              "users": [
                {
                  "$ref": "..."
                }
              ],
              "permIds": [
                826
              ],
              "permissions": [
                {
                  "id": 874,
                  "code": "99507",
                  "name": "marg.collier",
                  "permType": 28,
                  "parentId": 375,
                  "parentName": "marg.collier",
                  "path": "0hroxg",
                  "permLevel": 843,
                  "sortNo": 219,
                  "pattern": "9ypdj7",
                  "httpMethod": "ag2k04",
                  "isHidden": true,
                  "icon": "spcop7",
                  "terminalCode": "99507",
                  "menuDepth": 887,
                  "isQuick": true
                }
              ],
              "noPermission": true
            }
          ],
          "permissions": [
            {
              "id": 683,
              "code": "99507",
              "name": "marg.collier",
              "permType": 54,
              "parentId": 417,
              "parentName": "marg.collier",
              "path": "fvs6ia",
              "permLevel": 915,
              "sortNo": 474,
              "pattern": "76qu2a",
              "httpMethod": "30aihc",
              "isHidden": true,
              "icon": "65tyez",
              "terminalCode": "99507",
              "menuDepth": 200,
              "isQuick": true
            }
          ]
        }
      ],
      "permIds": [
        511
      ],
      "permissions": [
        {
          "id": 129,
          "code": "99507",
          "name": "marg.collier",
          "permType": 197,
          "parentId": 332,
          "parentName": "marg.collier",
          "path": "7w97xk",
          "permLevel": 117,
          "sortNo": 219,
          "pattern": "eld0nc",
          "httpMethod": "7sj1zs",
          "isHidden": true,
          "icon": "1eo4ny",
          "terminalCode": "99507",
          "menuDepth": 653,
          "isQuick": true
        }
      ],
      "noPermission": true
    }
  ],
  "time": "2023-02-13 08:31:53"
}

Curl-example:

curl -X GET -H 'Authorization' -i http://127.0.0.1:9010/sys/roles/all

3.25.6.

URL: http://127.0.0.1:9010/sys/roles/current/{username}

Type: GET

Author: Michael Li

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description:

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Path-parameters:

Parameter

Value

Type

Required

Description

username

string

true

No comments found.

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

└─any object

object

any object.

time

string

响应时间

Response-example:

{
  "code": 385,
  "msg": "dvekdw",
  "errorMsg": "gdugup",
  "success": true,
  "errorNo": "cwswkr",
  "data": {},
  "time": "2023-02-13 08:31:53"
}

Curl-example:

curl -X GET -H 'Authorization' -i http://127.0.0.1:9010/sys/roles/current/marg.collier

3.25.7.

URL: http://127.0.0.1:9010/sys/roles/{id}

Type: PUT

Author: Michael Li

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description:

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Path-parameters:

Parameter

Value

Type

Required

Description

int64

true

No comments found.

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

boolean

响应数据

time

string

响应时间

Response-example:

{
  "code": 975,
  "msg": "9p3772",
  "errorMsg": "dytlzq",
  "success": true,
  "errorNo": "298yvm",
  "data": true,
  "time": "2023-02-13 08:31:53"
}

Curl-example:

curl -X PUT -H 'Authorization' -i http://127.0.0.1:9010/sys/roles/296

3.25.8.

URL: http://127.0.0.1:9010/sys/roles/status/switch/batch

Type: POST

Author: Michael Li

Content-Type: application/json

Description:

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Body-parameters:

Parameter

Type

Required

Description

ids

array

false

角色ID列表

enabled

boolean

false

需要切换的状态

Request-body:

{
  "ids": [
    109
  ],
  "enabled": true
}

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

└─any object

object

any object.

time

string

响应时间

Response-example:

{
  "code": 636,
  "msg": "85mj0x",
  "errorMsg": "m5h2ei",
  "success": true,
  "errorNo": "1iseof",
  "data": {},
  "time": "2023-02-13 08:31:53"
}

Curl-example:

curl -X POST -H 'Content-Type: application/json' -H 'Authorization' -i http://127.0.0.1:9010/sys/roles/status/switch/batch --data '{
  "ids": [
    109
  ],
  "enabled": true
}'

3.25.9.

URL: http://127.0.0.1:9010/sys/roles/{id}/menuids/{terminalCode}

Type: GET

Author: Michael Li

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description:

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Path-parameters:

Parameter

Value

Type

Required

Description

int64

true

No comments found.

terminalCode

string

true

No comments found.

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

array

响应数据

time

string

响应时间

Response-example:

{
  "code": 742,
  "msg": "bdfxtq",
  "errorMsg": "35fhk1",
  "success": true,
  "errorNo": "4qtgk8",
  "data": [
    "ruqs1x",
    "zndgnk"
  ],
  "time": "2023-02-13 08:31:53"
}

Curl-example:

curl -X GET -H 'Authorization' -i http://127.0.0.1:9010/sys/roles/746/menuids/99507

3.25.10.

URL: http://127.0.0.1:9010/sys/roles/{id}/actionids

Type: GET

Author: Michael Li

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description:

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Path-parameters:

Parameter

Value

Type

Required

Description

int64

true

No comments found.

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

array

响应数据

time

string

响应时间

Response-example:

{
  "code": 104,
  "msg": "d4m6u1",
  "errorMsg": "4vkc4y",
  "success": true,
  "errorNo": "3j2psr",
  "data": [
    "tppcyp",
    "ag6itc"
  ],
  "time": "2023-02-13 08:31:53"
}

Curl-example:

curl -X GET -H 'Authorization' -i http://127.0.0.1:9010/sys/roles/13/actionids

3.25.11.

URL: http://127.0.0.1:9010/sys/roles/{id}/menus/{menuId}

Type: GET

Author: Michael Li

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description:

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Path-parameters:

Parameter

Value

Type

Required

Description

int64

true

No comments found.

menuId

int64

true

No comments found.

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

array

响应数据

└─id

int64

权限ID

└─code

string

权限代码

└─name

string

权限名称

└─permType

int32

权限类型: 1.菜单；0.按钮或API调用

└─parentId

int64

父权限ID

└─parentName

string

父权限名称"

└─path

string

权限层级路径

└─permLevel

int32

权限层级

└─sortNo

int32

排列顺序

└─pattern

string

URL路径

└─httpMethod

string

URL的HTTP方法

└─isHidden

boolean

菜单是否隐藏

└─icon

string

菜单图标

└─terminalCode

string

No comments found.

└─menuDepth

int32

菜单深度

└─isQuick

boolean

菜单是否隐藏

time

string

响应时间

Response-example:

{
  "code": 598,
  "msg": "5juzs2",
  "errorMsg": "3t5zaa",
  "success": true,
  "errorNo": "a10zn0",
  "data": [
    {
      "id": 24,
      "code": "99507",
      "name": "marg.collier",
      "permType": 460,
      "parentId": 843,
      "parentName": "marg.collier",
      "path": "70x2yq",
      "permLevel": 103,
      "sortNo": 645,
      "pattern": "c726qi",
      "httpMethod": "s38rk1",
      "isHidden": true,
      "icon": "23hhr0",
      "terminalCode": "99507",
      "menuDepth": 496,
      "isQuick": true
    }
  ],
  "time": "2023-02-13 08:31:53"
}

Curl-example:

curl -X GET -H 'Authorization' -i http://127.0.0.1:9010/sys/roles/637/menus/398

3.25.12.

URL: http://127.0.0.1:9010/sys/roles/{id}/menus/{menuId}

Type: POST

Author: Michael Li

Content-Type: application/json

Description:

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Path-parameters:

Parameter

Value

Type

Required

Description

int64

true

No comments found.

menuId

int64

true

No comments found.

Body-parameters:

Parameter

Type

Required

Description

permissionIds

array

false

No comments found.,[array of int64]@since

Request-body:

[]

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

└─any object

object

any object.

time

string

响应时间

Response-example:

{
  "code": 975,
  "msg": "n8ezts",
  "errorMsg": "s77q4d",
  "success": true,
  "errorNo": "h6ca4x",
  "data": {},
  "time": "2023-02-13 08:31:53"
}

Curl-example:

curl -X POST -H 'Content-Type: application/json' -H 'Authorization' -i http://127.0.0.1:9010/sys/roles/367/menus/368 --data '[]'

4. 文件服务

4.1. 数据导入导出

4.1.1. 下载模板文件

URL: http://127.0.0.1:9010/com/import/{tmplCode}/tmpl

Type: GET

Author: Kaiser（wang shao）

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 下载模板文件

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Path-parameters:

Parameter

Value

Type

Required

Description

tmplCode

string

true

模板编号

Response-example:

File download.

Curl-example:

curl -X GET -H 'Authorization' -i http://127.0.0.1:9010/com/import/99507/tmpl

4.1.2. 根据模板导入数据

URL: http://127.0.0.1:9010/com/import/{tmplCode}/data

Type: POST

Author: Kaiser（wang shao）

Content-Type: multipart/form-data

Description: 根据模板导入数据

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Path-parameters:

Parameter

Value

Type

Required

Description

tmplCode

string

true

模板编号

Query-parameters:

Parameter

Value

Type

Required

Description

file

true

数据文件

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

success

boolean

是否成功

data

object

响应数据

└─sync

boolean

是否是同步导入

└─syncResult

object

同步导入结果

└─total

int32

导入总数

└─numSuccess

int32

导入成功数量

└─failRecords

array

导入失败记录

└─asyncResult

object

异步导入结果

└─importId

int64

导入记录标识

time

string

响应时间

Response-example:

{
  "code": 990,
  "msg": "3param",
  "success": true,
  "data": {
    "sync": true,
    "syncResult": {
      "total": 871,
      "numSuccess": 324,
      "failRecords": [
        "utnugr"
      ]
    },
    "asyncResult": {
      "importId": 804
    }
  },
  "time": "2023-02-13 08:31:53"
}

Curl-example:

curl -X POST -H 'Content-Type: multipart/form-data' -H 'Authorization' -F 'file=' -i http://127.0.0.1:9010/com/import/99507/data

4.1.3. 根据模板导出数据

URL: http://127.0.0.1:9010/com/import/{tmplCode}/export

Type: POST

Author: Kaiser（wang shao）

Content-Type: application/json

Description: 根据模板导出数据

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Path-parameters:

Parameter

Value

Type

Required

Description

tmplCode

string

true

模板编号

Body-parameters:

Parameter

Type

Required

Description

any object

object

false

any object.

Request-body:

{}

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

success

boolean

是否成功

data

object

响应数据

└─sync

boolean

是否是同步导出

└─recordId

int64

导出记录的唯一标识

time

string

响应时间

Response-example:

{
  "code": 181,
  "msg": "naiey8",
  "success": true,
  "data": {
    "sync": true,
    "recordId": 854
  },
  "time": "2023-02-13 08:31:53"
}

Curl-example:

curl -X POST -H 'Content-Type: application/json' -H 'Authorization' -i http://127.0.0.1:9010/com/import/99507/export --data '{}'

4.1.4. 下载导出的数据文件

URL: http://127.0.0.1:9010/com/import/export/{recordId}/file

Type: GET

Author: Kaiser（wang shao）

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 下载导出的数据文件

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Path-parameters:

Parameter

Value

Type

Required

Description

recordId

int64

true

导出记录ID

Response-example:

File download.

Curl-example:

curl -X GET -H 'Authorization' -i http://127.0.0.1:9010/com/import/export/688/file

4.1.5. 查询导入（或导出）进度

URL: http://127.0.0.1:9010/com/import/{recordId}/rate

Type: GET

Author: Kaiser（wang shao）

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 查询导入（或导出）进度

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Path-parameters:

Parameter

Value

Type

Required

Description

recordId

int64

true

导入(导出)记录ID

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

success

boolean

是否成功

data

object

响应数据

└─finish

boolean

是否导入完毕

└─total

int32

记录总数

└─count

int32

已导入数量

└─rate

string

导入进度（百分比形式）

time

string

响应时间

Response-example:

{
  "code": 56,
  "msg": "el3ed1",
  "success": true,
  "data": {
    "finish": true,
    "total": 298,
    "count": 346,
    "rate": "zwi72l"
  },
  "time": "2023-02-13 08:31:53"
}

Curl-example:

curl -X GET -H 'Authorization' -i http://127.0.0.1:9010/com/import/927/rate

4.2. 文件管理

4.2.1. 上传单文件

URL: http://127.0.0.1:9010/com/file/v1/upload

Type: POST

Author: Kaiser（wang shao）

Content-Type: multipart/form-data

Description: 上传单文件

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Query-parameters:

Parameter

Value

Type

Required

Description

file

true

文件

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

success

boolean

是否成功

data

object

响应数据

└─fileCode

string

文件编码，文件服务器上的文件唯一标

└─originalName

string

文件原名称

└─fileSize

int64

文件大小，字节B

└─suffix

string

文件名后缀

└─mimeType

string

文件内容类型，mime-type

└─fileType

enum

常见的文件类型（IMAGE-图片，AUDIO-音频，VIDEO-视频），为空则表示不常见
IMAGE
AUDIO
VIDEO

└─uploadTime

string

上传时间

└─filePath

string

文件路径

└─width

int32

宽度，图片时有值

└─height

int32

高度，图片时有值

└─urlPreview

string

文件预览url

└─urlDownload

string

文件下载url

└─urlDelete

string

文件删除url

└─url

string

外部可访问的完整链接

└─extraInfo

object

扩展参数

time

string

响应时间

Response-example:

{
  "code": 535,
  "msg": "pk1rew",
  "success": true,
  "data": {
    "fileCode": "99507",
    "originalName": "marg.collier",
    "fileSize": 225,
    "suffix": "b3snwc",
    "mimeType": "t7vqn5",
    "fileType": "IMAGE",
    "uploadTime": "2023-02-13 08:31:53",
    "filePath": "538d5g",
    "width": 568,
    "height": 854,
    "urlPreview": "2x2yqj",
    "urlDownload": "ef7csm",
    "urlDelete": "brhabe",
    "url": "www.williams-bashirian.biz",
    "extraInfo": {}
  },
  "time": "2023-02-13 08:31:53"
}

Curl-example:

curl -X POST -H 'Content-Type: multipart/form-data' -H 'Authorization' -F 'file=' -i http://127.0.0.1:9010/com/file/v1/upload

4.2.2. 查询单个文件信息

URL: http://127.0.0.1:9010/com/file/v1/{fileCode}

Type: GET

Author: Kaiser（wang shao）

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 查询单个文件信息

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Path-parameters:

Parameter

Value

Type

Required

Description

fileCode

string

true

文件编码

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

success

boolean

是否成功

data

object

响应数据

└─fileCode

string

文件编码，文件服务器上的文件唯一标

└─originalName

string

文件原名称

└─fileSize

int64

文件大小，字节B

└─suffix

string

文件名后缀

└─mimeType

string

文件内容类型，mime-type

└─fileType

enum

常见的文件类型（IMAGE-图片，AUDIO-音频，VIDEO-视频），为空则表示不常见
IMAGE
AUDIO
VIDEO

└─uploadTime

string

上传时间

└─filePath

string

文件路径

└─width

int32

宽度，图片时有值

└─height

int32

高度，图片时有值

└─urlPreview

string

文件预览url

└─urlDownload

string

文件下载url

└─urlDelete

string

文件删除url

└─url

string

外部可访问的完整链接

└─extraInfo

object

扩展参数

time

string

响应时间

Response-example:

{
  "code": 244,
  "msg": "993kgv",
  "success": true,
  "data": {
    "fileCode": "99507",
    "originalName": "marg.collier",
    "fileSize": 224,
    "suffix": "v0xoxv",
    "mimeType": "uks5wx",
    "fileType": "IMAGE",
    "uploadTime": "2023-02-13 08:31:53",
    "filePath": "fct9bm",
    "width": 816,
    "height": 919,
    "urlPreview": "ebl8ui",
    "urlDownload": "oic7ac",
    "urlDelete": "b7jzf3",
    "url": "www.williams-bashirian.biz",
    "extraInfo": {}
  },
  "time": "2023-02-13 08:31:53"
}

Curl-example:

curl -X GET -H 'Authorization' -i http://127.0.0.1:9010/com/file/v1/99507

4.2.3. 查询单个文件信息

URL: http://127.0.0.1:9010/com/file/v1/query

Type: POST

Author: Kaiser（wang shao）

Content-Type: application/json

Description: 查询单个文件信息

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Body-parameters:

Parameter

Type

Required

Description

fileCodes

array

false

文件编码,[array of string]@since

Request-body:

[]

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

success

boolean

是否成功

data

array

响应数据

└─fileCode

string

文件编码，文件服务器上的文件唯一标

└─originalName

string

文件原名称

└─fileSize

int64

文件大小，字节B

└─suffix

string

文件名后缀

└─mimeType

string

文件内容类型，mime-type

└─fileType

enum

常见的文件类型（IMAGE-图片，AUDIO-音频，VIDEO-视频），为空则表示不常见
IMAGE
AUDIO
VIDEO

└─uploadTime

string

上传时间

└─filePath

string

文件路径

└─width

int32

宽度，图片时有值

└─height

int32

高度，图片时有值

└─urlPreview

string

文件预览url

└─urlDownload

string

文件下载url

└─urlDelete

string

文件删除url

└─url

string

外部可访问的完整链接

└─extraInfo

object

扩展参数

time

string

响应时间

Response-example:

{
  "code": 925,
  "msg": "wrmmm6",
  "success": true,
  "data": [
    {
      "fileCode": "99507",
      "originalName": "marg.collier",
      "fileSize": 423,
      "suffix": "chpmvk",
      "mimeType": "dyyv8h",
      "fileType": "IMAGE",
      "uploadTime": "2023-02-13 08:31:53",
      "filePath": "h4dilt",
      "width": 954,
      "height": 87,
      "urlPreview": "k2hy6a",
      "urlDownload": "hjvm2f",
      "urlDelete": "dq7duh",
      "url": "www.williams-bashirian.biz",
      "extraInfo": {}
    }
  ],
  "time": "2023-02-13 08:31:53"
}

Curl-example:

curl -X POST -H 'Content-Type: application/json' -H 'Authorization' -i http://127.0.0.1:9010/com/file/v1/query --data '[]'

4.2.4. 显示图片

URL: http://127.0.0.1:9010/com/file/v1/{fileCode}/show

Type: GET

Author: Kaiser（wang shao）

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 显示图片

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Path-parameters:

Parameter

Value

Type

Required

Description

fileCode

string

true

文件编码

Query-parameters:

Parameter

Value

Type

Required

Description

thumbnail

boolean

false

是否是预览缩略图

Response-example:

File download.

Curl-example:

curl -X GET -H 'Authorization' -i http://127.0.0.1:9010/com/file/v1/99507/show?thumbnail=true

4.2.5. 下载文件

URL: http://127.0.0.1:9010/com/file/v1/{fileCode}/download

Type: GET

Author: Kaiser（wang shao）

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 下载文件

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Path-parameters:

Parameter

Value

Type

Required

Description

fileCode

string

true

文件编码

Response-example:

File download.

Curl-example:

curl -X GET -H 'Authorization' -i http://127.0.0.1:9010/com/file/v1/99507/download

4.2.6. 删除文件

URL: http://127.0.0.1:9010/com/file/v1/{fileCode}

Type: DELETE

Author: Kaiser（wang shao）

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 删除文件

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Path-parameters:

Parameter

Value

Type

Required

Description

fileCode

string

true

文件编码

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

success

boolean

是否成功

data

string

响应数据

time

string

响应时间

Response-example:

{
  "code": 777,
  "msg": "4aald6",
  "success": true,
  "data": "6oda1i",
  "time": "2023-02-13 08:31:53"
}

Curl-example:

curl -X DELETE -H 'Authorization' -i http://127.0.0.1:9010/com/file/v1/99507

4.2.7. 批量删除文件

URL: http://127.0.0.1:9010/com/file/v1/delete

Type: DELETE

Author: Kaiser（wang shao）

Content-Type: application/json

Description: 批量删除文件

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Body-parameters:

Parameter

Type

Required

Description

fileCodes

array

false

文件编码,[array of string]@since

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

success

boolean

是否成功

data

array

响应数据

time

string

响应时间

Response-example:

{
  "code": 409,
  "msg": "d7f9u0",
  "success": true,
  "data": [
    "c5kyrw",
    "q5em57"
  ],
  "time": "2023-02-13 08:31:53"
}

Curl-example:

curl -X DELETE -H 'Content-Type: application/json' -H 'Authorization' -i http://127.0.0.1:9010/com/file/v1/delete --data '[]'

5. 租户管理

5.1. 租户数据库创建.

5.1.1. 获取租户的数据库创建记录

URL: http://127.0.0.1:9010/sys/sysTenant/dbMigrate/{tenantId}/record

Type: GET

Author: Kaiser（wang shao）

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 获取租户的数据库创建记录

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Path-parameters:

Parameter

Value

Type

Required

Description

tenantId

int64

true

租户ID

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

array

响应数据

└─id

int64

记录ID

└─appCode

string

应用编码

└─migrateStartTime

string

创建开始时间

└─migrateSuccess

boolean

是否创建成功

└─migrateFinishTime

string

创建结束时间

└─failReason

string

创建失败原因

time

string

响应时间

Response-example:

{
  "code": 828,
  "msg": "4ax5e1",
  "errorMsg": "z3roo3",
  "success": true,
  "errorNo": "phazhr",
  "data": [
    {
      "id": 181,
      "appCode": "99507",
      "migrateStartTime": "2023-02-13 08:31:53",
      "migrateSuccess": true,
      "migrateFinishTime": "2023-02-13 08:31:53",
      "failReason": "nsfz7w"
    }
  ],
  "time": "2023-02-13 08:31:53"
}

Curl-example:

curl -X GET -H 'Authorization' -i http://127.0.0.1:9010/sys/sysTenant/dbMigrate/887/record

5.1.2. 创建租户数据库

URL: http://127.0.0.1:9010/sys/sysTenant/dbMigrate/{tenantId}/start

Type: POST

Author: Kaiser（wang shao）

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 创建租户数据库

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Path-parameters:

Parameter

Value

Type

Required

Description

tenantId

int64

true

租户ID

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

int64

响应数据

time

string

响应时间

Response-example:

{
  "code": 396,
  "msg": "bcuzdn",
  "errorMsg": "mu059o",
  "success": true,
  "errorNo": "zpzjd2",
  "data": 665,
  "time": "2023-02-13 08:31:53"
}

Curl-example:

curl -X POST -H 'Authorization' -i http://127.0.0.1:9010/sys/sysTenant/dbMigrate/744/start

5.1.3. 重新执行指定的数据库创建

URL: http://127.0.0.1:9010/sys/sysTenant/dbMigrate/{id}/retry

Type: POST

Author: Kaiser（wang shao）

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 重新执行指定的数据库创建

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Path-parameters:

Parameter

Value

Type

Required

Description

int64

true

记录ID

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

int64

响应数据

time

string

响应时间

Response-example:

{
  "code": 501,
  "msg": "yzj128",
  "errorMsg": "81qrny",
  "success": true,
  "errorNo": "uknt43",
  "data": 562,
  "time": "2023-02-13 08:31:53"
}

Curl-example:

curl -X POST -H 'Authorization' -i http://127.0.0.1:9010/sys/sysTenant/dbMigrate/679/retry

5.1.4. 删除租户数据库

URL: http://127.0.0.1:9010/sys/sysTenant/dbMigrate/{tenantId}/delete

Type: DELETE

Author: Kaiser（wang shao）

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 删除租户数据库

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Path-parameters:

Parameter

Value

Type

Required

Description

tenantId

int64

true

租户ID

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

int64

响应数据

time

string

响应时间

Response-example:

{
  "code": 698,
  "msg": "b4yidw",
  "errorMsg": "an0xnt",
  "success": true,
  "errorNo": "2wxq3a",
  "data": 906,
  "time": "2023-02-13 08:31:53"
}

Curl-example:

curl -X DELETE -H 'Authorization' -i http://127.0.0.1:9010/sys/sysTenant/dbMigrate/244/delete

5.2. 租户与发号器的绑定.

5.2.1. 租户绑定发号器

URL: http://127.0.0.1:9010/sys/tenant/number_rule/{tenantId}/bind

Type: POST

Author: Kaiser（wang shao）

Content-Type: application/json

Description: 租户绑定发号器

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Path-parameters:

Parameter

Value

Type

Required

Description

tenantId

int64

true

租户ID

Body-parameters:

Parameter

Type

Required

Description

numberRuleIds

array

false

发号器ID列表,[array of int64]@since

Request-body:

[]

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

boolean

响应数据

time

string

响应时间

Response-example:

{
  "code": 770,
  "msg": "0ki8jm",
  "errorMsg": "fj49bc",
  "success": true,
  "errorNo": "03ak6z",
  "data": true,
  "time": "2023-02-13 08:31:53"
}

Curl-example:

curl -X POST -H 'Content-Type: application/json' -H 'Authorization' -i http://127.0.0.1:9010/sys/tenant/number_rule/85/bind --data '[]'

5.2.2. 租户绑定所有发号器

URL: http://127.0.0.1:9010/sys/tenant/number_rule/{tenantId}/bind_all

Type: POST

Author: Kaiser（wang shao）

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 租户绑定所有发号器

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Path-parameters:

Parameter

Value

Type

Required

Description

tenantId

int64

true

租户ID

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

boolean

响应数据

time

string

响应时间

Response-example:

{
  "code": 634,
  "msg": "477wv2",
  "errorMsg": "z23ipr",
  "success": true,
  "errorNo": "wnp14s",
  "data": true,
  "time": "2023-02-13 08:31:53"
}

Curl-example:

curl -X POST -H 'Authorization' -i http://127.0.0.1:9010/sys/tenant/number_rule/367/bind_all

5.2.3. 租户解绑发号器

URL: http://127.0.0.1:9010/sys/tenant/number_rule/{tenantId}/unbind

Type: POST

Author: Kaiser（wang shao）

Content-Type: application/json

Description: 租户解绑发号器

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Path-parameters:

Parameter

Value

Type

Required

Description

tenantId

int64

true

租户ID

Body-parameters:

Parameter

Type

Required

Description

numberRuleIds

array

false

发号器ID列表,[array of int64]@since

Request-body:

[]

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

boolean

响应数据

time

string

响应时间

Response-example:

{
  "code": 192,
  "msg": "r8i12o",
  "errorMsg": "v9q94m",
  "success": true,
  "errorNo": "ief7zr",
  "data": true,
  "time": "2023-02-13 08:31:53"
}

Curl-example:

curl -X POST -H 'Content-Type: application/json' -H 'Authorization' -i http://127.0.0.1:9010/sys/tenant/number_rule/588/unbind --data '[]'

5.2.4. 租户解绑所有发号器

URL: http://127.0.0.1:9010/sys/tenant/number_rule/{tenantId}/unbind_all

Type: POST

Author: Kaiser（wang shao）

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 租户解绑所有发号器

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Path-parameters:

Parameter

Value

Type

Required

Description

tenantId

int64

true

租户ID

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

boolean

响应数据

time

string

响应时间

Response-example:

{
  "code": 629,
  "msg": "tsoyiw",
  "errorMsg": "wcvbyb",
  "success": true,
  "errorNo": "i9fgsm",
  "data": true,
  "time": "2023-02-13 08:31:53"
}

Curl-example:

curl -X POST -H 'Authorization' -i http://127.0.0.1:9010/sys/tenant/number_rule/170/unbind_all

5.2.5. 分页查询租户的发号器关联

URL: http://127.0.0.1:9010/sys/tenant/number_rule/query_by_page

Type: POST

Author: Kaiser（wang shao）

Content-Type: application/json

Description: 分页查询租户的发号器关联

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Body-parameters:

Parameter

Type

Required

Description

current

int32

false

页码

size

int32

false

页大小

keyword

string

false

搜索关键字

orders

array

false

排序

└─column

string

false

属性名称

└─asc

boolean

false

是否升序

sysTenantId

int64

true

租户ID

bound

boolean

false

是否是绑定过的

ruleCode

string

false

规则编码

ruleName

string

false

规则名称，模糊查询

ruleClass

string

false

规则分类码

Request-body:

{
  "current": 503,
  "size": 10,
  "keyword": "rghy08",
  "orders": [
    {
      "column": "cbywrn",
      "asc": true
    }
  ],
  "sysTenantId": 276,
  "bound": true,
  "ruleCode": "99507",
  "ruleName": "marg.collier",
  "ruleClass": "3h4v5p"
}

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

└─total

int64

总记录数

└─records

array

数据列表

└─id

int64

绑定记录ID

└─sysTenantId

int64

租户ID

└─sysNumberRuleId

int64

发号器规则ID

└─bound

boolean

是否已绑定

└─bindTime

string

绑定时间

└─ruleCode

string

规则编号

└─ruleName

string

规则名称

└─ruleClass

string

规则分类码，[UDC]COM:DOMAIN

└─ruleClassName

string

规则分类码名称

└─sampleCode

string

取号示例

└─createTime

string

发号器创建时间

time

string

响应时间

Response-example:

{
  "code": 871,
  "msg": "odci76",
  "errorMsg": "llkp37",
  "success": true,
  "errorNo": "wypg1f",
  "data": {
    "total": 72,
    "records": [
      {
        "id": 382,
        "sysTenantId": 317,
        "sysNumberRuleId": 969,
        "bound": true,
        "bindTime": "2023-02-13 08:31:53",
        "ruleCode": "99507",
        "ruleName": "marg.collier",
        "ruleClass": "k7ler3",
        "ruleClassName": "marg.collier",
        "sampleCode": "99507",
        "createTime": "2023-02-13 08:31:53"
      }
    ]
  },
  "time": "2023-02-13 08:31:53"
}

Curl-example:

curl -X POST -H 'Content-Type: application/json' -H 'Authorization' -i http://127.0.0.1:9010/sys/tenant/number_rule/query_by_page --data '{
  "current": 503,
  "size": 10,
  "keyword": "rghy08",
  "orders": [
    {
      "column": "cbywrn",
      "asc": true
    }
  ],
  "sysTenantId": 276,
  "bound": true,
  "ruleCode": "99507",
  "ruleName": "marg.collier",
  "ruleClass": "3h4v5p"
}'

5.3. 租户管理

5.3.1. 创建租户

URL: http://127.0.0.1:9010/sys/sysTenant/createOne

Type: POST

Author: roman.zhang

Content-Type: application/json

Description: 创建租户

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Body-parameters:

Parameter

Type

Required

Description

tenantCode

string

true

租户编码

tenantName

string

true

租户名称

enabled

boolean

false

是否启用

adminAccount

string

true

管理员登录账号

linkman

string

false

联系人

contactNumber

string

true

联系人手机号

address

string

false

联系地址

tenantIsolation

string

false

租户数据隔离：DATABASE：数据库，SCHEMA：schema, FIELD：字段
现阶段只支持SCHEMA，所以无需前端传参

databaseSourceId

int64

false

租户数据隔离数据源ID

schemaName

string

true

租户数据隔离：DATABASE：数据库，SCHEMA：schema, FIELD：字段

tenantDomain

string

false

域名地址

customDomain

string

false

租户自定义域名地址

industry

string

false

所属行业，[UDC]COM:INDUSTRY

customer

string

false

所属客户，[UDC]SYS:CUSTOMER

remark

string

false

备注

Request-body:

{
  "tenantCode": "99507",
  "tenantName": "marg.collier",
  "enabled": true,
  "adminAccount": "jr2lnz",
  "linkman": "uotycs",
  "contactNumber": "12shpg",
  "address": "0966 Barbra Square， North Basilia， ME 39552",
  "tenantIsolation": "9tvikl",
  "databaseSourceId": 344,
  "schemaName": "marg.collier",
  "tenantDomain": "marquardt.org",
  "customDomain": "marquardt.org",
  "industry": "jq5c3l",
  "customer": "3jbklq",
  "remark": "99pc0w"
}

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

int64

响应数据

time

string

响应时间

Response-example:

{
  "code": 819,
  "msg": "f22go4",
  "errorMsg": "3730iz",
  "success": true,
  "errorNo": "vfc4yp",
  "data": 23,
  "time": "2023-02-13 08:31:53"
}

Curl-example:

curl -X POST -H 'Content-Type: application/json' -H 'Authorization' -i http://127.0.0.1:9010/sys/sysTenant/createOne --data '{
  "tenantCode": "99507",
  "tenantName": "marg.collier",
  "enabled": true,
  "adminAccount": "jr2lnz",
  "linkman": "uotycs",
  "contactNumber": "12shpg",
  "address": "0966 Barbra Square， North Basilia， ME 39552",
  "tenantIsolation": "9tvikl",
  "databaseSourceId": 344,
  "schemaName": "marg.collier",
  "tenantDomain": "marquardt.org",
  "customDomain": "marquardt.org",
  "industry": "jq5c3l",
  "customer": "3jbklq",
  "remark": "99pc0w"
}'

5.3.2. 更新租户

URL: http://127.0.0.1:9010/sys/sysTenant/update

Type: PUT

Author: roman.zhang

Content-Type: application/json

Description: 更新租户

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Body-parameters:

Parameter

Type

Required

Description

int64

true

租户ID

tenantCode

string

true

租户编码

tenantName

string

true

租户名称

enabled

boolean

false

是否启用

linkman

string

false

联系人

contactNumber

string

true

联系人手机号

address

string

false

联系地址

tenantIsolation

string

false

租户数据隔离：DATABASE：数据库，SCHEMA：schema, FIELD：字段
现阶段只支持SCHEMA，所以无需前端传参

databaseSourceId

int64

false

租户数据隔离数据源ID

schemaName

string

true

租户数据隔离：DATABASE：数据库，SCHEMA：schema, FIELD：字段

tenantDomain

string

false

域名地址

customDomain

string

false

租户自定义域名地址

industry

string

false

所属行业，[UDC]COM:INDUSTRY

customer

string

false

所属客户，[UDC]SYS:CUSTOMER

remark

string

false

备注

Request-body:

{
  "id": 552,
  "tenantCode": "99507",
  "tenantName": "marg.collier",
  "enabled": true,
  "linkman": "t5te16",
  "contactNumber": "z6hy6i",
  "address": "0966 Barbra Square， North Basilia， ME 39552",
  "tenantIsolation": "zhc2uj",
  "databaseSourceId": 159,
  "schemaName": "marg.collier",
  "tenantDomain": "marquardt.org",
  "customDomain": "marquardt.org",
  "industry": "3l9u24",
  "customer": "zox50z",
  "remark": "95jjbg"
}

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

int64

响应数据

time

string

响应时间

Response-example:

{
  "code": 26,
  "msg": "9x7i7e",
  "errorMsg": "ovecbv",
  "success": true,
  "errorNo": "p63ujl",
  "data": 807,
  "time": "2023-02-13 08:31:53"
}

Curl-example:

curl -X PUT -H 'Content-Type: application/json' -H 'Authorization' -i http://127.0.0.1:9010/sys/sysTenant/update --data '{
  "id": 552,
  "tenantCode": "99507",
  "tenantName": "marg.collier",
  "enabled": true,
  "linkman": "t5te16",
  "contactNumber": "z6hy6i",
  "address": "0966 Barbra Square， North Basilia， ME 39552",
  "tenantIsolation": "zhc2uj",
  "databaseSourceId": 159,
  "schemaName": "marg.collier",
  "tenantDomain": "marquardt.org",
  "customDomain": "marquardt.org",
  "industry": "3l9u24",
  "customer": "zox50z",
  "remark": "95jjbg"
}'

5.3.3. 通过ID查询租户详细信息

URL: http://127.0.0.1:9010/sys/sysTenant/findIdOne/{id}

Type: GET

Author: roman.zhang

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 通过ID查询租户详细信息

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Path-parameters:

Parameter

Value

Type

Required

Description

int64

true

主键

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

└─id

int64

租户ID

└─tenantCode

string

租户编码

└─tenantName

string

租户名称

└─enabled

boolean

是否启用

└─adminAccount

string

管理员登录账号

└─linkman

string

联系人

└─contactNumber

string

联系电话

└─address

string

联系地址

└─dbInitialized

boolean

No comments found.

└─schemaName

string

schema名称，支持英文字母、数字和下划线

└─tenantDomain

string

域名地址

└─customDomain

string

租户自定义域名

└─industry

string

所属行业，[UDC]COM:INDUSTRY

└─industryName

string

所属行业

└─customer

string

所属客户，[UDC]SYS:CUSTOMER

└─customerName

string

所属客户

└─remark

string

备注

└─createTime

string

记录创建时间

└─creator

string

记录创建人

└─modifyTime

string

记录最后更新时间

└─updater

string

记录最后更新者

time

string

响应时间

Response-example:

{
  "code": 438,
  "msg": "j75lpl",
  "errorMsg": "8cv1n7",
  "success": true,
  "errorNo": "ugd4wa",
  "data": {
    "id": 635,
    "tenantCode": "99507",
    "tenantName": "marg.collier",
    "enabled": true,
    "adminAccount": "11sxlh",
    "linkman": "9jsgbn",
    "contactNumber": "5cqblf",
    "address": "0966 Barbra Square， North Basilia， ME 39552",
    "dbInitialized": true,
    "schemaName": "marg.collier",
    "tenantDomain": "marquardt.org",
    "customDomain": "marquardt.org",
    "industry": "e4ya6c",
    "industryName": "marg.collier",
    "customer": "yz1yl4",
    "customerName": "marg.collier",
    "remark": "kesvmy",
    "createTime": "2023-02-13 08:31:53",
    "creator": "3b123z",
    "modifyTime": "2023-02-13 08:31:53",
    "updater": "a2ehog"
  },
  "time": "2023-02-13 08:31:53"
}

Curl-example:

curl -X GET -H 'Authorization' -i http://127.0.0.1:9010/sys/sysTenant/findIdOne/400

5.3.4. 分页查询

URL: http://127.0.0.1:9010/sys/sysTenant/search

Type: POST

Author: roman.zhang

Content-Type: application/json

Description: 分页查询

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Body-parameters:

Parameter

Type

Required

Description

current

int32

false

页码

size

int32

false

页大小

keyword

string

false

搜索关键字

orders

array

false

排序

└─column

string

false

属性名称

└─asc

boolean

false

是否升序

tenantCode

string

false

租户编码

tenantName

string

false

租户名称

enabled

boolean

false

是否启用

linkman

string

false

联系人

contactNumber

string

false

联系电话

schemaName

string

false

schema名称，支持英文字母、数字和下划线

tenantDomain

string

false

域名地址

customDomain

string

false

租户自定义域名

industry

string

false

所属行业，[UDC]COM:INDUSTRY

customer

string

false

所属客户，[UDC]SYS:CUSTOMER

Request-body:

{
  "current": 171,
  "size": 10,
  "keyword": "8ua1eh",
  "orders": [
    {
      "column": "ry38lk",
      "asc": true
    }
  ],
  "tenantCode": "99507",
  "tenantName": "marg.collier",
  "enabled": true,
  "linkman": "xcvq50",
  "contactNumber": "rpygn3",
  "schemaName": "marg.collier",
  "tenantDomain": "marquardt.org",
  "customDomain": "marquardt.org",
  "industry": "a16gg4",
  "customer": "hgg6cn"
}

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

└─total

int64

总记录数

└─records

array

数据列表

└─id

int64

租户ID

└─tenantCode

string

租户编码

└─tenantName

string

租户名称

└─enabled

boolean

是否启用

└─adminAccount

string

管理员登录账号

└─linkman

string

联系人

└─contactNumber

string

联系电话

└─address

string

联系地址

└─dbInitialized

boolean

No comments found.

└─schemaName

string

schema名称，支持英文字母、数字和下划线

└─tenantDomain

string

域名地址

└─customDomain

string

租户自定义域名

└─industry

string

所属行业，[UDC]COM:INDUSTRY

└─industryName

string

所属行业

└─customer

string

所属客户，[UDC]SYS:CUSTOMER

└─customerName

string

所属客户

└─remark

string

备注

└─createTime

string

记录创建时间

└─creator

string

记录创建人

└─modifyTime

string

记录最后更新时间

└─updater

string

记录最后更新者

time

string

响应时间

Response-example:

{
  "code": 326,
  "msg": "i0kfp2",
  "errorMsg": "50ye1x",
  "success": true,
  "errorNo": "1dl1uw",
  "data": {
    "total": 52,
    "records": [
      {
        "id": 607,
        "tenantCode": "99507",
        "tenantName": "marg.collier",
        "enabled": true,
        "adminAccount": "r2c7wu",
        "linkman": "7lwrue",
        "contactNumber": "th0i5a",
        "address": "0966 Barbra Square， North Basilia， ME 39552",
        "dbInitialized": true,
        "schemaName": "marg.collier",
        "tenantDomain": "marquardt.org",
        "customDomain": "marquardt.org",
        "industry": "4crpm4",
        "industryName": "marg.collier",
        "customer": "5upvo6",
        "customerName": "marg.collier",
        "remark": "08uv39",
        "createTime": "2023-02-13 08:31:53",
        "creator": "pl3nwc",
        "modifyTime": "2023-02-13 08:31:53",
        "updater": "ab7q6r"
      }
    ]
  },
  "time": "2023-02-13 08:31:53"
}

Curl-example:

curl -X POST -H 'Content-Type: application/json' -H 'Authorization' -i http://127.0.0.1:9010/sys/sysTenant/search --data '{
  "current": 171,
  "size": 10,
  "keyword": "8ua1eh",
  "orders": [
    {
      "column": "ry38lk",
      "asc": true
    }
  ],
  "tenantCode": "99507",
  "tenantName": "marg.collier",
  "enabled": true,
  "linkman": "xcvq50",
  "contactNumber": "rpygn3",
  "schemaName": "marg.collier",
  "tenantDomain": "marquardt.org",
  "customDomain": "marquardt.org",
  "industry": "a16gg4",
  "customer": "hgg6cn"
}'

5.3.5. 启用租户

URL: http://127.0.0.1:9010/sys/sysTenant/{id}/enabled

Type: PATCH

Author: roman.zhang

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 启用租户

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Path-parameters:

Parameter

Value

Type

Required

Description

int64

true

租户ID

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

int64

响应数据

time

string

响应时间

Response-example:

{
  "code": 230,
  "msg": "bfacd2",
  "errorMsg": "eumi4y",
  "success": true,
  "errorNo": "8kohti",
  "data": 173,
  "time": "2023-02-13 08:31:53"
}

Curl-example:

curl -X PATCH -H 'Authorization' -i http://127.0.0.1:9010/sys/sysTenant/542/enabled

5.3.6. 禁用租户

URL: http://127.0.0.1:9010/sys/sysTenant/{id}/disabled

Type: PATCH

Author: roman.zhang

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 禁用租户

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Path-parameters:

Parameter

Value

Type

Required

Description

int64

true

租户ID

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

int64

响应数据

time

string

响应时间

Response-example:

{
  "code": 416,
  "msg": "khe7bj",
  "errorMsg": "wtoti0",
  "success": true,
  "errorNo": "qzvvsi",
  "data": 439,
  "time": "2023-02-13 08:31:53"
}

Curl-example:

curl -X PATCH -H 'Authorization' -i http://127.0.0.1:9010/sys/sysTenant/534/disabled

5.3.7. 更新数据源绑定

URL: http://127.0.0.1:9010/sys/sysTenant/update/{id}/datasource/{datasourceId}

Type: PATCH

Author: roman.zhang

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 更新数据源绑定

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Path-parameters:

Parameter

Value

Type

Required

Description

int64

true

租户ID

datasourceId

int64

true

数据源ID

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

int64

响应数据

time

string

响应时间

Response-example:

{
  "code": 79,
  "msg": "ej66ua",
  "errorMsg": "vpfk0l",
  "success": true,
  "errorNo": "5y64wn",
  "data": 517,
  "time": "2023-02-13 08:31:53"
}

Curl-example:

curl -X PATCH -H 'Authorization' -i http://127.0.0.1:9010/sys/sysTenant/update/886/datasource/465

5.3.8. 根据主键删除数据

URL: http://127.0.0.1:9010/sys/sysTenant/deleteOne/{id}

Type: DELETE

Author: roman.zhang

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据主键删除数据

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Path-parameters:

Parameter

Value

Type

Required

Description

int64

true

主键

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

int64

响应数据

time

string

响应时间

Response-example:

{
  "code": 875,
  "msg": "e8iqf8",
  "errorMsg": "l5nsm2",
  "success": true,
  "errorNo": "oi3aux",
  "data": 381,
  "time": "2023-02-13 08:31:53"
}

Curl-example:

curl -X DELETE -H 'Authorization' -i http://127.0.0.1:9010/sys/sysTenant/deleteOne/112

5.3.9. 批量删除

URL: http://127.0.0.1:9010/sys/sysTenant/deleteBatch

Type: DELETE

Author: roman.zhang

Content-Type: application/json

Description: 批量删除

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Body-parameters:

Parameter

Type

Required

Description

ids

array

false

删除数据集合,[array of int64]@since

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

array

响应数据

time

string

响应时间

Response-example:

{
  "code": 868,
  "msg": "pksm70",
  "errorMsg": "s26jkz",
  "success": true,
  "errorNo": "t8ttjf",
  "data": [
    69,
    322
  ],
  "time": "2023-02-13 08:31:53"
}

Curl-example:

curl -X DELETE -H 'Content-Type: application/json' -H 'Authorization' -i http://127.0.0.1:9010/sys/sysTenant/deleteBatch --data '[]'

5.3.10. 逻辑删除

URL: http://127.0.0.1:9010/sys/sysTenant/updateDeleteFlag/{id}

Type: PUT

Author: roman.zhang

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 逻辑删除

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Path-parameters:

Parameter

Value

Type

Required

Description

int64

true

更新数据

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

└─any object

object

any object.

time

string

响应时间

Response-example:

{
  "code": 398,
  "msg": "sxhczp",
  "errorMsg": "mqh358",
  "success": true,
  "errorNo": "v5hvi1",
  "data": {},
  "time": "2023-02-13 08:31:53"
}

Curl-example:

curl -X PUT -H 'Authorization' -i http://127.0.0.1:9010/sys/sysTenant/updateDeleteFlag/361

5.4. 租户API接口.

5.4.1. 获取所有租户

URL: http://127.0.0.1:9010/api/tenant/all

Type: GET

Author: Kaiser（wang shao）

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 获取所有租户

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

array

响应数据

└─id

int64

租户ID

└─tenantCode

string

租户编码

└─tenantName

string

租户名称

└─linkman

string

联系人

└─address

string

联系地址

└─tenantDomain

string

域名地址，二级域名部分

└─customDomain

string

租户自己的域名

time

string

响应时间

Response-example:

{
  "code": 393,
  "msg": "no52ip",
  "errorMsg": "bmdie5",
  "success": true,
  "errorNo": "qmx8qp",
  "data": [
    {
      "id": 109,
      "tenantCode": "99507",
      "tenantName": "marg.collier",
      "linkman": "zvx8gj",
      "address": "0966 Barbra Square， North Basilia， ME 39552",
      "tenantDomain": "marquardt.org",
      "customDomain": "marquardt.org"
    }
  ],
  "time": "2023-02-13 08:31:53"
}

Curl-example:

curl -X GET -H 'Authorization' -i http://127.0.0.1:9010/api/tenant/all

5.4.2. 分页查询租户信息

URL: http://127.0.0.1:9010/api/tenant/query

Type: POST

Author: Kaiser（wang shao）

Content-Type: application/json

Description: 分页查询租户信息

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Body-parameters:

Parameter

Type

Required

Description

current

int32

false

页码

size

int32

false

页大小

keyword

string

false

搜索关键字

orders

array

false

排序

└─column

string

false

属性名称

└─asc

boolean

false

是否升序

tenantName

string

false

租户名称

tenantCode

string

false

租户编码

Request-body:

{
  "current": 893,
  "size": 10,
  "keyword": "t26gux",
  "orders": [
    {
      "column": "3875iv",
      "asc": true
    }
  ],
  "tenantName": "marg.collier",
  "tenantCode": "99507"
}

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

object

响应数据

└─total

int64

总记录数

└─records

array

数据列表

└─id

int64

租户ID

└─tenantCode

string

租户编码

└─tenantName

string

租户名称

└─linkman

string

联系人

└─address

string

联系地址

└─tenantDomain

string

域名地址，二级域名部分

└─customDomain

string

租户自己的域名

time

string

响应时间

Response-example:

{
  "code": 667,
  "msg": "3h5pvy",
  "errorMsg": "lwv4b3",
  "success": true,
  "errorNo": "fsj4hl",
  "data": {
    "total": 618,
    "records": [
      {
        "id": 494,
        "tenantCode": "99507",
        "tenantName": "marg.collier",
        "linkman": "bsymgi",
        "address": "0966 Barbra Square， North Basilia， ME 39552",
        "tenantDomain": "marquardt.org",
        "customDomain": "marquardt.org"
      }
    ]
  },
  "time": "2023-02-13 08:31:53"
}

Curl-example:

curl -X POST -H 'Content-Type: application/json' -H 'Authorization' -i http://127.0.0.1:9010/api/tenant/query --data '{
  "current": 893,
  "size": 10,
  "keyword": "t26gux",
  "orders": [
    {
      "column": "3875iv",
      "asc": true
    }
  ],
  "tenantName": "marg.collier",
  "tenantCode": "99507"
}'

5.5. 租户用户管理

5.5.1. 给用户绑定租户

URL: http://127.0.0.1:9010/sys/tenant/user/{userId}/bind/{tenantId}

Type: PUT

Author: roman.zhang

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 给用户绑定租户

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Path-parameters:

Parameter

Value

Type

Required

Description

userId

int64

true

用户ID

tenantId

int64

true

租户ID

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

int64

响应数据

time

string

响应时间

Response-example:

{
  "code": 855,
  "msg": "z6flxn",
  "errorMsg": "cfg4eg",
  "success": true,
  "errorNo": "7lz59k",
  "data": 133,
  "time": "2023-02-13 08:31:53"
}

Curl-example:

curl -X PUT -H 'Authorization' -i http://127.0.0.1:9010/sys/tenant/user/68/bind/538

5.5.2. 给用户解绑租户

URL: http://127.0.0.1:9010/sys/tenant/user/{userId}/unbind/{tenantId}

Type: PUT

Author: roman.zhang

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 给用户解绑租户

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Path-parameters:

Parameter

Value

Type

Required

Description

userId

int64

true

用户ID

tenantId

int64

true

租户ID

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

int64

响应数据

time

string

响应时间

Response-example:

{
  "code": 840,
  "msg": "8caen0",
  "errorMsg": "k84mn8",
  "success": true,
  "errorNo": "lghcz2",
  "data": 81,
  "time": "2023-02-13 08:31:53"
}

Curl-example:

curl -X PUT -H 'Authorization' -i http://127.0.0.1:9010/sys/tenant/user/646/unbind/183

5.5.3. 查询用户绑定的租户信息

URL: http://127.0.0.1:9010/sys/tenant/user/tenants

Type: GET

Author: roman.zhang

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 查询用户绑定的租户信息

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Query-parameters:

Parameter

Value

Type

Required

Description

sysUserId

int64

false

用户ID

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

array

响应数据

└─sysUserId

int64

用户ID

└─sysTenantId

int64

租户的唯一标识

└─bindTime

string

绑定时间

└─tenantCode

int64

租户ID

└─tenantName

string

租户名称

└─tenantDomain

string

租户域名

└─customDomain

string

自定义域名

time

string

响应时间

Response-example:

{
  "code": 631,
  "msg": "1e7wx0",
  "errorMsg": "es2na6",
  "success": true,
  "errorNo": "l6ox6i",
  "data": [
    {
      "sysUserId": 673,
      "sysTenantId": 799,
      "bindTime": "2023-02-13 08:31:53",
      "tenantCode": 681,
      "tenantName": "marg.collier",
      "tenantDomain": "marquardt.org",
      "customDomain": "marquardt.org"
    }
  ],
  "time": "2023-02-13 08:31:53"
}

Curl-example:

curl -X GET -H 'Authorization' -i http://127.0.0.1:9010/sys/tenant/user/tenants?sysUserId=85

5.5.4. 设置当前登录的租户

URL: http://127.0.0.1:9010/sys/tenant/user/setCurrentTenant/{tenantId}

Type: GET

Author: roman.zhang

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 设置当前登录的租户

Request-headers:

Header

Value

Type

Required

Description

Authorization

String

false

Access Token

Path-parameters:

Parameter

Value

Type

Required

Description

tenantId

int64

true

租户ID

Response-fields:

Field

Type

Description

Since

code

int32

响应码

msg

string

响应消息

errorMsg

string

错误信息

success

boolean

是否成功

errorNo

string

错误号

data

boolean

响应数据

time

string

响应时间

Response-example:

{
  "code": 463,
  "msg": "90qb2j",
  "errorMsg": "ut05ou",
  "success": true,
  "errorNo": "352qd3",
  "data": true,
  "time": "2023-02-13 08:31:53"
}

Curl-example:

curl -X GET -H 'Authorization' -i http://127.0.0.1:9010/sys/tenant/user/setCurrentTenant/438

Top

系统域-system