1.common/demo/请假demo

1.1.新建

Type: POST

Author: zhangyongqiang

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

Description: 新建

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

id

int64

No comments found.

false

-

remark

string

No comments found.

false

-

createUserId

int64

No comments found.

false

-

creator

string

记录创建者

false

-

createTime

string

No comments found.

false

-

modifyUserId

int64

No comments found.

false

-

modifyTime

string

No comments found.

false

-

deleteFlag

int32

No comments found.

false

-

ignoreWarning

boolean

No comments found.

false

-

nullFields

array

No comments found.

false

-

changeLogId

int64

No comments found.

false

-

leaveNo

string

No comments found.

false

-

leaveName

string

No comments found.

false

-

userId

int64

No comments found.

false

-

orgId

int64

No comments found.

false

-

ouId

int64

No comments found.

false

-

days

int32

No comments found.

false

-

startDate

string

No comments found.

false

-

endDate

string

No comments found.

false

-

ext1

string

No comments found.

false

-

ext2

string

No comments found.

false

-

ext3

string

No comments found.

false

-

ext4

string

No comments found.

false

-

ext5

string

No comments found.

false

-

ext6

string

No comments found.

false

-

ext7

string

No comments found.

false

-

ext8

string

No comments found.

false

-

ext9

string

No comments found.

false

-

ext10

string

No comments found.

false

-

Request-example:

curl -X POST -H 'Authorization' -i /api/demo/leave --data 'id=542&remark=mmy4st&createUserId=536&creator=9ld2ia&createTime=2023-09-27 17:34:56&modifyUserId=502&modifyTime=2023-09-27 17:34:56&deleteFlag=0&ignoreWarning=true&nullFields=upvlgi,upvlgi&changeLogId=25&leaveNo=yimqve&leaveName=gil.paucek&userId=921&orgId=634&ouId=929&days=230&startDate=2023-09-27&endDate=2023-09-27&ext1=pp9i5v&ext2=d7t7ej&ext3=8st8fk&ext4=wi5xcw&ext5=y4g1qg&ext6=5q9qvr&ext7=rdfnxp&ext8=uelp8w&ext9=hh3ywj&ext10=axemok'

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

└─tenantId

int64

租户ID

-

└─remark

string

备注

-

└─createUserId

int64

记录创建者ID

-

└─creator

string

记录创建者

-

└─createTime

string

记录创建时间

-

└─modifyUserId

int64

记录最后更新者ID

-

└─updater

string

记录最后更新者

-

└─modifyTime

string

记录最后更新时间

-

└─deleteFlag

int32

逻辑删除标识

-

└─auditDataVersion

int32

锁版本

-

└─id

int64

No comments found.

-

└─name

string

No comments found.

-

└─leaveNo

string

No comments found.

-

└─leaveName

string

No comments found.

-

└─userId

int64

No comments found.

-

└─orgId

int64

No comments found.

-

└─ouId

int64

No comments found.

-

└─days

int32

No comments found.

-

└─startDate

string

No comments found.

-

└─endDate

string

No comments found.

-

└─ext1

string

No comments found.

-

└─ext2

string

No comments found.

-

└─ext3

string

No comments found.

-

└─ext4

string

No comments found.

-

└─ext5

string

No comments found.

-

└─ext6

string

No comments found.

-

└─ext7

string

No comments found.

-

└─ext8

string

No comments found.

-

└─ext9

string

No comments found.

-

└─ext10

string

No comments found.

-

└─userIdDesc

string

No comments found.

-

└─orgIdDesc

string

No comments found.

-

└─ouIdDesc

string

No comments found.

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {
    "tenantId": 144,
    "remark": "2n5n4p",
    "createUserId": 926,
    "creator": "mdq3c9",
    "createTime": "2023-09-27 17:34:56",
    "modifyUserId": 516,
    "updater": "2chaix",
    "modifyTime": "2023-09-27 17:34:56",
    "deleteFlag": 0,
    "auditDataVersion": 915,
    "id": 273,
    "name": "gil.paucek",
    "leaveNo": "ml6o1d",
    "leaveName": "gil.paucek",
    "userId": 151,
    "orgId": 920,
    "ouId": 789,
    "days": 527,
    "startDate": "2023-09-27",
    "endDate": "2023-09-27",
    "ext1": "9t40fd",
    "ext2": "fzfah7",
    "ext3": "8q4lwu",
    "ext4": "v19c86",
    "ext5": "0gp1lh",
    "ext6": "x11g7c",
    "ext7": "4wutuc",
    "ext8": "b65eg0",
    "ext9": "a8ap5r",
    "ext10": "ta2sor",
    "userIdDesc": "krcxef",
    "orgIdDesc": "3rryik",
    "ouIdDesc": "8rc80m"
  },
  "infos": [
    {
      "localeCode": "88129",
      "msg": "a5jpf7",
      "defaultMsg": "bhd1ho",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "nvd62h",
      "defaultMsg": "42jsnr",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "msks9i",
      "defaultMsg": "26xhbs",
      "context": {
        "object": "any object"
      }
    }
  ]
}

1.2.全部修改

Type: PUT

Author: zhangyongqiang

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

Description: 全部修改

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

id

int64

No comments found.

false

-

remark

string

No comments found.

false

-

createUserId

int64

No comments found.

false

-

creator

string

记录创建者

false

-

createTime

string

No comments found.

false

-

modifyUserId

int64

No comments found.

false

-

modifyTime

string

No comments found.

false

-

deleteFlag

int32

No comments found.

false

-

ignoreWarning

boolean

No comments found.

false

-

nullFields

array

No comments found.

false

-

changeLogId

int64

No comments found.

false

-

leaveNo

string

No comments found.

false

-

leaveName

string

No comments found.

false

-

userId

int64

No comments found.

false

-

orgId

int64

No comments found.

false

-

ouId

int64

No comments found.

false

-

days

int32

No comments found.

false

-

startDate

string

No comments found.

false

-

endDate

string

No comments found.

false

-

ext1

string

No comments found.

false

-

ext2

string

No comments found.

false

-

ext3

string

No comments found.

false

-

ext4

string

No comments found.

false

-

ext5

string

No comments found.

false

-

ext6

string

No comments found.

false

-

ext7

string

No comments found.

false

-

ext8

string

No comments found.

false

-

ext9

string

No comments found.

false

-

ext10

string

No comments found.

false

-

Request-example:

curl -X PUT -H 'Authorization' -i /api/demo/leave --data 'id=880&remark=kgn97l&createUserId=735&creator=7okws8&createTime=2023-09-27 17:34:56&modifyUserId=259&modifyTime=2023-09-27 17:34:56&deleteFlag=0&ignoreWarning=true&nullFields=r6f1jp,r6f1jp&changeLogId=946&leaveNo=6mn4oi&leaveName=gil.paucek&userId=39&orgId=619&ouId=216&days=441&startDate=2023-09-27&endDate=2023-09-27&ext1=h2i48o&ext2=8s2zdo&ext3=7qprhi&ext4=mnaqwm&ext5=x9z41x&ext6=sr1jtb&ext7=6f31j9&ext8=cmwwa1&ext9=ndntbw&ext10=xiuu7b'

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

└─tenantId

int64

租户ID

-

└─remark

string

备注

-

└─createUserId

int64

记录创建者ID

-

└─creator

string

记录创建者

-

└─createTime

string

记录创建时间

-

└─modifyUserId

int64

记录最后更新者ID

-

└─updater

string

记录最后更新者

-

└─modifyTime

string

记录最后更新时间

-

└─deleteFlag

int32

逻辑删除标识

-

└─auditDataVersion

int32

锁版本

-

└─id

int64

No comments found.

-

└─name

string

No comments found.

-

└─leaveNo

string

No comments found.

-

└─leaveName

string

No comments found.

-

└─userId

int64

No comments found.

-

└─orgId

int64

No comments found.

-

└─ouId

int64

No comments found.

-

└─days

int32

No comments found.

-

└─startDate

string

No comments found.

-

└─endDate

string

No comments found.

-

└─ext1

string

No comments found.

-

└─ext2

string

No comments found.

-

└─ext3

string

No comments found.

-

└─ext4

string

No comments found.

-

└─ext5

string

No comments found.

-

└─ext6

string

No comments found.

-

└─ext7

string

No comments found.

-

└─ext8

string

No comments found.

-

└─ext9

string

No comments found.

-

└─ext10

string

No comments found.

-

└─userIdDesc

string

No comments found.

-

└─orgIdDesc

string

No comments found.

-

└─ouIdDesc

string

No comments found.

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {
    "tenantId": 709,
    "remark": "m91xlt",
    "createUserId": 860,
    "creator": "89xsin",
    "createTime": "2023-09-27 17:34:56",
    "modifyUserId": 104,
    "updater": "vhxcyz",
    "modifyTime": "2023-09-27 17:34:56",
    "deleteFlag": 0,
    "auditDataVersion": 69,
    "id": 258,
    "name": "gil.paucek",
    "leaveNo": "vzj390",
    "leaveName": "gil.paucek",
    "userId": 694,
    "orgId": 186,
    "ouId": 176,
    "days": 774,
    "startDate": "2023-09-27",
    "endDate": "2023-09-27",
    "ext1": "gdfjxu",
    "ext2": "zey0tf",
    "ext3": "viebev",
    "ext4": "y0av80",
    "ext5": "ubd6s8",
    "ext6": "e4g81u",
    "ext7": "vlp7dv",
    "ext8": "cfqtjh",
    "ext9": "6v93hf",
    "ext10": "cr6p80",
    "userIdDesc": "8yhuu1",
    "orgIdDesc": "dngix4",
    "ouIdDesc": "ulw4pe"
  },
  "infos": [
    {
      "localeCode": "88129",
      "msg": "apejqx",
      "defaultMsg": "khsji1",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "umijtz",
      "defaultMsg": "d6pcqw",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "dtmzq8",
      "defaultMsg": "ixwoel",
      "context": {
        "object": "any object"
      }
    }
  ]
}

1.3.动态修改（仅修改属性不为null的字段，如果需要将字段设置为null，请设置 `nullFields` 属性）

Type: PUT

Author: zhangyongqiang

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

Description: 动态修改（仅修改属性不为null的字段，如果需要将字段设置为null，请设置 `nullFields` 属性）

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

id

int64

No comments found.

false

-

remark

string

No comments found.

false

-

createUserId

int64

No comments found.

false

-

creator

string

记录创建者

false

-

createTime

string

No comments found.

false

-

modifyUserId

int64

No comments found.

false

-

modifyTime

string

No comments found.

false

-

deleteFlag

int32

No comments found.

false

-

ignoreWarning

boolean

No comments found.

false

-

nullFields

array

No comments found.

false

-

changeLogId

int64

No comments found.

false

-

leaveNo

string

No comments found.

false

-

leaveName

string

No comments found.

false

-

userId

int64

No comments found.

false

-

orgId

int64

No comments found.

false

-

ouId

int64

No comments found.

false

-

days

int32

No comments found.

false

-

startDate

string

No comments found.

false

-

endDate

string

No comments found.

false

-

ext1

string

No comments found.

false

-

ext2

string

No comments found.

false

-

ext3

string

No comments found.

false

-

ext4

string

No comments found.

false

-

ext5

string

No comments found.

false

-

ext6

string

No comments found.

false

-

ext7

string

No comments found.

false

-

ext8

string

No comments found.

false

-

ext9

string

No comments found.

false

-

ext10

string

No comments found.

false

-

Request-example:

curl -X PUT -H 'Authorization' -i /api/demo/leave/updateDynamic --data 'id=653&remark=rj8lf2&createUserId=601&creator=yolt8q&createTime=2023-09-27 17:34:56&modifyUserId=424&modifyTime=2023-09-27 17:34:56&deleteFlag=0&ignoreWarning=true&nullFields=4h1a5i,4h1a5i&changeLogId=243&leaveNo=8ar62k&leaveName=gil.paucek&userId=363&orgId=456&ouId=681&days=972&startDate=2023-09-27&endDate=2023-09-27&ext1=o5le0c&ext2=rts772&ext3=eyf02v&ext4=lqa5td&ext5=zoj0i5&ext6=vrurm2&ext7=qgquqi&ext8=tmj1ro&ext9=15euei&ext10=rk1o89'

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

└─tenantId

int64

租户ID

-

└─remark

string

备注

-

└─createUserId

int64

记录创建者ID

-

└─creator

string

记录创建者

-

└─createTime

string

记录创建时间

-

└─modifyUserId

int64

记录最后更新者ID

-

└─updater

string

记录最后更新者

-

└─modifyTime

string

记录最后更新时间

-

└─deleteFlag

int32

逻辑删除标识

-

└─auditDataVersion

int32

锁版本

-

└─id

int64

No comments found.

-

└─name

string

No comments found.

-

└─leaveNo

string

No comments found.

-

└─leaveName

string

No comments found.

-

└─userId

int64

No comments found.

-

└─orgId

int64

No comments found.

-

└─ouId

int64

No comments found.

-

└─days

int32

No comments found.

-

└─startDate

string

No comments found.

-

└─endDate

string

No comments found.

-

└─ext1

string

No comments found.

-

└─ext2

string

No comments found.

-

└─ext3

string

No comments found.

-

└─ext4

string

No comments found.

-

└─ext5

string

No comments found.

-

└─ext6

string

No comments found.

-

└─ext7

string

No comments found.

-

└─ext8

string

No comments found.

-

└─ext9

string

No comments found.

-

└─ext10

string

No comments found.

-

└─userIdDesc

string

No comments found.

-

└─orgIdDesc

string

No comments found.

-

└─ouIdDesc

string

No comments found.

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {
    "tenantId": 698,
    "remark": "qwefnz",
    "createUserId": 926,
    "creator": "tfkphk",
    "createTime": "2023-09-27 17:34:56",
    "modifyUserId": 367,
    "updater": "9406jl",
    "modifyTime": "2023-09-27 17:34:56",
    "deleteFlag": 0,
    "auditDataVersion": 950,
    "id": 811,
    "name": "gil.paucek",
    "leaveNo": "e2vqoy",
    "leaveName": "gil.paucek",
    "userId": 392,
    "orgId": 561,
    "ouId": 564,
    "days": 842,
    "startDate": "2023-09-27",
    "endDate": "2023-09-27",
    "ext1": "c7mrtp",
    "ext2": "bb4ku9",
    "ext3": "qxuf7p",
    "ext4": "13fmmu",
    "ext5": "a53p1h",
    "ext6": "tshf7c",
    "ext7": "6q1n9a",
    "ext8": "phvabu",
    "ext9": "av6vrw",
    "ext10": "mza8nv",
    "userIdDesc": "53kis0",
    "orgIdDesc": "moabop",
    "ouIdDesc": "tv7qg5"
  },
  "infos": [
    {
      "localeCode": "88129",
      "msg": "u3at30",
      "defaultMsg": "z9yff4",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "ocbj0t",
      "defaultMsg": "tze3og",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "d1c7vo",
      "defaultMsg": "o8okhy",
      "context": {
        "object": "any object"
      }
    }
  ]
}

1.4.主键查询

Type: GET

Author: zhangyongqiang

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

Description: 主键查询

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Path-parameters:

ParameterTypeDescriptionRequiredSince

key

int64

key

true

-

Request-example:

curl -X GET -H 'Authorization' -i /api/demo/leave/117

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

└─tenantId

int64

租户ID

-

└─remark

string

备注

-

└─createUserId

int64

记录创建者ID

-

└─creator

string

记录创建者

-

└─createTime

string

记录创建时间

-

└─modifyUserId

int64

记录最后更新者ID

-

└─updater

string

记录最后更新者

-

└─modifyTime

string

记录最后更新时间

-

└─deleteFlag

int32

逻辑删除标识

-

└─auditDataVersion

int32

锁版本

-

└─id

int64

No comments found.

-

└─name

string

No comments found.

-

└─leaveNo

string

No comments found.

-

└─leaveName

string

No comments found.

-

└─userId

int64

No comments found.

-

└─orgId

int64

No comments found.

-

└─ouId

int64

No comments found.

-

└─days

int32

No comments found.

-

└─startDate

string

No comments found.

-

└─endDate

string

No comments found.

-

└─ext1

string

No comments found.

-

└─ext2

string

No comments found.

-

└─ext3

string

No comments found.

-

└─ext4

string

No comments found.

-

└─ext5

string

No comments found.

-

└─ext6

string

No comments found.

-

└─ext7

string

No comments found.

-

└─ext8

string

No comments found.

-

└─ext9

string

No comments found.

-

└─ext10

string

No comments found.

-

└─userIdDesc

string

No comments found.

-

└─orgIdDesc

string

No comments found.

-

└─ouIdDesc

string

No comments found.

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {
    "tenantId": 440,
    "remark": "sw4e3t",
    "createUserId": 485,
    "creator": "sm75vo",
    "createTime": "2023-09-27 17:34:56",
    "modifyUserId": 890,
    "updater": "a6imrt",
    "modifyTime": "2023-09-27 17:34:56",
    "deleteFlag": 0,
    "auditDataVersion": 246,
    "id": 683,
    "name": "gil.paucek",
    "leaveNo": "desel9",
    "leaveName": "gil.paucek",
    "userId": 644,
    "orgId": 654,
    "ouId": 425,
    "days": 205,
    "startDate": "2023-09-27",
    "endDate": "2023-09-27",
    "ext1": "5qun8t",
    "ext2": "a0yk1r",
    "ext3": "w68weh",
    "ext4": "9op5qt",
    "ext5": "ff1nhc",
    "ext6": "93i622",
    "ext7": "pjnv1t",
    "ext8": "sexyuq",
    "ext9": "swkajs",
    "ext10": "tx0tso",
    "userIdDesc": "0sokps",
    "orgIdDesc": "cdilfh",
    "ouIdDesc": "lumq6f"
  },
  "infos": [
    {
      "localeCode": "88129",
      "msg": "bwqnyn",
      "defaultMsg": "r7sajx",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "nk55x0",
      "defaultMsg": "z5skuo",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "664l88",
      "defaultMsg": "0zs6h3",
      "context": {
        "object": "any object"
      }
    }
  ]
}

1.5.分页查询

Type: GET

Author: zhangyongqiang

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

Description: 分页查询

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

current

int32

页码，默认为1

false

-

size

int32

页大小，默认为10

false

-

keyword

string

搜索关键字

false

-

idSet

object

ID

false

-

orders

array

排序

false

-

└─column

string

属性名称

false

-

└─asc

boolean

是否升序

false

-

id

int64

No comments found.

false

-

remark

string

No comments found.

false

-

createUserId

int64

No comments found.

false

-

loginUserId

int64

登录用户id 用于数据权限

false

-

createTimeStart

string

No comments found.

false

-

createTimeEnd

string

No comments found.

false

-

modifyUserId

int64

No comments found.

false

-

modifyTimeStart

string

No comments found.

false

-

modifyTimeEnd

string

No comments found.

false

-

dataPermissionFlag

boolean

No comments found.

false

-

leaveNo

string

No comments found.

false

-

leaveName

string

No comments found.

false

-

userId

int64

No comments found.

false

-

orgId

int64

No comments found.

false

-

ouId

int64

No comments found.

false

-

days

int32

No comments found.

false

-

startDate

string

No comments found.

false

-

endDate

string

No comments found.

false

-

ext1

string

No comments found.

false

-

ext2

string

No comments found.

false

-

ext3

string

No comments found.

false

-

ext4

string

No comments found.

false

-

ext5

string

No comments found.

false

-

ext6

string

No comments found.

false

-

ext7

string

No comments found.

false

-

ext8

string

No comments found.

false

-

ext9

string

No comments found.

false

-

ext10

string

No comments found.

false

-

Request-example:

curl -X GET -H 'Authorization' -i /api/demo/leave/paging?current=844&size=10&keyword=sev66y&column=4lojpf&asc=true&id=211&remark=k7g5ba&createUserId=377&loginUserId=291&createTimeStart=2023-09-27 17:34:56&createTimeEnd=2023-09-27 17:34:56&modifyUserId=304&modifyTimeStart=2023-09-27 17:34:56&modifyTimeEnd=2023-09-27 17:34:56&dataPermissionFlag=true&leaveNo=04hqid&leaveName=gil.paucek&userId=523&orgId=585&ouId=341&days=396&startDate=2023-09-27&endDate=2023-09-27&ext1=p2a2kq&ext2=w27y5e&ext3=dsz28a&ext4=puli2c&ext5=ylp0f8&ext6=ci3umh&ext7=cqukdd&ext8=s1d26z&ext9=aegdzj&ext10=1ivhs0&orders[0].column=ujm08r&orders[0].asc=true

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

└─total

int64

总记录数

-

└─records

array

数据列表

-

     └─tenantId

int64

租户ID

-

     └─remark

string

备注

-

     └─createUserId

int64

记录创建者ID

-

     └─creator

string

记录创建者

-

     └─createTime

string

记录创建时间

-

     └─modifyUserId

int64

记录最后更新者ID

-

     └─updater

string

记录最后更新者

-

     └─modifyTime

string

记录最后更新时间

-

     └─deleteFlag

int32

逻辑删除标识

-

     └─auditDataVersion

int32

锁版本

-

     └─id

int64

No comments found.

-

     └─name

string

No comments found.

-

     └─leaveNo

string

No comments found.

-

     └─leaveName

string

No comments found.

-

     └─userId

int64

No comments found.

-

     └─orgId

int64

No comments found.

-

     └─ouId

int64

No comments found.

-

     └─days

int32

No comments found.

-

     └─startDate

string

No comments found.

-

     └─endDate

string

No comments found.

-

     └─ext1

string

No comments found.

-

     └─ext2

string

No comments found.

-

     └─ext3

string

No comments found.

-

     └─ext4

string

No comments found.

-

     └─ext5

string

No comments found.

-

     └─ext6

string

No comments found.

-

     └─ext7

string

No comments found.

-

     └─ext8

string

No comments found.

-

     └─ext9

string

No comments found.

-

     └─ext10

string

No comments found.

-

     └─userIdDesc

string

No comments found.

-

     └─orgIdDesc

string

No comments found.

-

     └─ouIdDesc

string

No comments found.

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {
    "total": 832,
    "records": [
      {
        "tenantId": 637,
        "remark": "kfi5k7",
        "createUserId": 926,
        "creator": "63alp0",
        "createTime": "2023-09-27 17:34:56",
        "modifyUserId": 14,
        "updater": "xdvu35",
        "modifyTime": "2023-09-27 17:34:57",
        "deleteFlag": 0,
        "auditDataVersion": 699,
        "id": 864,
        "name": "gil.paucek",
        "leaveNo": "6n1hjx",
        "leaveName": "gil.paucek",
        "userId": 761,
        "orgId": 480,
        "ouId": 61,
        "days": 944,
        "startDate": "2023-09-27",
        "endDate": "2023-09-27",
        "ext1": "i3yjmj",
        "ext2": "w6k7zl",
        "ext3": "fvx0jc",
        "ext4": "qwdjvk",
        "ext5": "nhfm6b",
        "ext6": "jselu1",
        "ext7": "1myu8n",
        "ext8": "69f59h",
        "ext9": "sf428x",
        "ext10": "o8yqz3",
        "userIdDesc": "hc98l1",
        "orgIdDesc": "efdcjy",
        "ouIdDesc": "83bihg"
      }
    ]
  },
  "infos": [
    {
      "localeCode": "88129",
      "msg": "xmqqgh",
      "defaultMsg": "ukq9r5",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "utbo90",
      "defaultMsg": "6888ad",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "0imlqw",
      "defaultMsg": "paalf9",
      "context": {
        "object": "any object"
      }
    }
  ]
}

1.6.列表查询

Type: GET

Author: zhangyongqiang

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

Description: 列表查询

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

current

int32

页码，默认为1

false

-

size

int32

页大小，默认为10

false

-

keyword

string

搜索关键字

false

-

idSet

object

ID

false

-

orders

array

排序

false

-

└─column

string

属性名称

false

-

└─asc

boolean

是否升序

false

-

id

int64

No comments found.

false

-

remark

string

No comments found.

false

-

createUserId

int64

No comments found.

false

-

loginUserId

int64

登录用户id 用于数据权限

false

-

createTimeStart

string

No comments found.

false

-

createTimeEnd

string

No comments found.

false

-

modifyUserId

int64

No comments found.

false

-

modifyTimeStart

string

No comments found.

false

-

modifyTimeEnd

string

No comments found.

false

-

dataPermissionFlag

boolean

No comments found.

false

-

leaveNo

string

No comments found.

false

-

leaveName

string

No comments found.

false

-

userId

int64

No comments found.

false

-

orgId

int64

No comments found.

false

-

ouId

int64

No comments found.

false

-

days

int32

No comments found.

false

-

startDate

string

No comments found.

false

-

endDate

string

No comments found.

false

-

ext1

string

No comments found.

false

-

ext2

string

No comments found.

false

-

ext3

string

No comments found.

false

-

ext4

string

No comments found.

false

-

ext5

string

No comments found.

false

-

ext6

string

No comments found.

false

-

ext7

string

No comments found.

false

-

ext8

string

No comments found.

false

-

ext9

string

No comments found.

false

-

ext10

string

No comments found.

false

-

Request-example:

curl -X GET -H 'Authorization' -i /api/demo/leave/list?current=726&size=10&keyword=tzmowu&column=pryrmj&asc=true&id=351&remark=xpblcx&createUserId=521&loginUserId=914&createTimeStart=2023-09-27 17:34:57&createTimeEnd=2023-09-27 17:34:57&modifyUserId=661&modifyTimeStart=2023-09-27 17:34:57&modifyTimeEnd=2023-09-27 17:34:57&dataPermissionFlag=true&leaveNo=994xd2&leaveName=gil.paucek&userId=306&orgId=436&ouId=480&days=315&startDate=2023-09-27&endDate=2023-09-27&ext1=e4j4t7&ext2=hipa6c&ext3=u7w5or&ext4=ftjm91&ext5=amzcts&ext6=i1kxo0&ext7=ayc5gy&ext8=0lk5mh&ext9=6qbw3f&ext10=w8fdnl&orders[0].asc=true&orders[0].column=zwseg4

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

array

业务数据

-

└─tenantId

int64

租户ID

-

└─remark

string

备注

-

└─createUserId

int64

记录创建者ID

-

└─creator

string

记录创建者

-

└─createTime

string

记录创建时间

-

└─modifyUserId

int64

记录最后更新者ID

-

└─updater

string

记录最后更新者

-

└─modifyTime

string

记录最后更新时间

-

└─deleteFlag

int32

逻辑删除标识

-

└─auditDataVersion

int32

锁版本

-

└─id

int64

No comments found.

-

└─name

string

No comments found.

-

└─leaveNo

string

No comments found.

-

└─leaveName

string

No comments found.

-

└─userId

int64

No comments found.

-

└─orgId

int64

No comments found.

-

└─ouId

int64

No comments found.

-

└─days

int32

No comments found.

-

└─startDate

string

No comments found.

-

└─endDate

string

No comments found.

-

└─ext1

string

No comments found.

-

└─ext2

string

No comments found.

-

└─ext3

string

No comments found.

-

└─ext4

string

No comments found.

-

└─ext5

string

No comments found.

-

└─ext6

string

No comments found.

-

└─ext7

string

No comments found.

-

└─ext8

string

No comments found.

-

└─ext9

string

No comments found.

-

└─ext10

string

No comments found.

-

└─userIdDesc

string

No comments found.

-

└─orgIdDesc

string

No comments found.

-

└─ouIdDesc

string

No comments found.

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": [
    {
      "tenantId": 171,
      "remark": "o61r0r",
      "createUserId": 767,
      "creator": "31dtdm",
      "createTime": "2023-09-27 17:34:57",
      "modifyUserId": 884,
      "updater": "ry86u7",
      "modifyTime": "2023-09-27 17:34:57",
      "deleteFlag": 0,
      "auditDataVersion": 293,
      "id": 853,
      "name": "gil.paucek",
      "leaveNo": "ew57l9",
      "leaveName": "gil.paucek",
      "userId": 712,
      "orgId": 426,
      "ouId": 411,
      "days": 873,
      "startDate": "2023-09-27",
      "endDate": "2023-09-27",
      "ext1": "acome9",
      "ext2": "dibrls",
      "ext3": "h4ipad",
      "ext4": "13o9uz",
      "ext5": "4mp2po",
      "ext6": "wbe17z",
      "ext7": "rva1hj",
      "ext8": "p94nek",
      "ext9": "9j5xpr",
      "ext10": "08hdzc",
      "userIdDesc": "aqimkw",
      "orgIdDesc": "2kfo6g",
      "ouIdDesc": "296sbi"
    }
  ],
  "infos": [
    {
      "localeCode": "88129",
      "msg": "no8fzr",
      "defaultMsg": "wjs9jb",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "ktkv33",
      "defaultMsg": "x7gn1o",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "nau1w1",
      "defaultMsg": "ichw82",
      "context": {
        "object": "any object"
      }
    }
  ]
}

1.7.删除

Type: PATCH

Author: zhangyongqiang

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

Description: 删除

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

keys

array

keys,[array of int64]

false

-

Request-example:

curl -X PATCH -H 'Authorization' -i /api/demo/leave?keys=vjb4ho&keys=vjb4ho

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

array

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": [
    227,
    894
  ],
  "infos": [
    {
      "localeCode": "88129",
      "msg": "ly9ydf",
      "defaultMsg": "7v9516",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "v82mxq",
      "defaultMsg": "4zwyib",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "x35o2y",
      "defaultMsg": "x8kvwm",
      "context": {
        "object": "any object"
      }
    }
  ]
}

2.租户授权

2.1.新增

Type: POST

Author: duwh

Content-Type: application/json

Description: 新增

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Body-parameters:

ParameterTypeDescriptionRequiredSince

id

int64

No comments found.

false

-

remark

string

No comments found.

false

-

createUserId

int64

No comments found.

false

-

creator

string

记录创建者

false

-

createTime

string

No comments found.

false

-

modifyUserId

int64

No comments found.

false

-

modifyTime

string

No comments found.

false

-

deleteFlag

int32

No comments found.

false

-

ignoreWarning

boolean

No comments found.

false

-

nullFields

array

No comments found.

false

-

changeLogId

int64

No comments found.

false

-

authTenantId

int64

授权租户数据

false

-

authType

string

授权模块 UDC 下拉选择项

false

-

Request-example:

curl -X POST -H 'Content-Type: application/json' -H 'Authorization' -i /api/tenant/authTenant --data '{
  "id": 742,
  "remark": "saj52c",
  "createUserId": 183,
  "creator": "obkr9y",
  "createTime": "2023-09-27 17:34:57",
  "modifyUserId": 867,
  "modifyTime": "2023-09-27 17:34:57",
  "deleteFlag": 0,
  "ignoreWarning": true,
  "nullFields": [
    "e1jbte"
  ],
  "changeLogId": 527,
  "authTenantId": 404,
  "authType": "sl6fwn"
}'

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "7yblc8",
      "defaultMsg": "42kgc4",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "5a41r4",
      "defaultMsg": "fknh0j",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "h6xqp3",
      "defaultMsg": "cfnwzo",
      "context": {
        "object": "any object"
      }
    }
  ]
}

2.2.更新

Type: PUT

Author: duwh

Content-Type: application/json

Description: 更新

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Body-parameters:

ParameterTypeDescriptionRequiredSince

id

int64

No comments found.

false

-

remark

string

No comments found.

false

-

createUserId

int64

No comments found.

false

-

creator

string

记录创建者

false

-

createTime

string

No comments found.

false

-

modifyUserId

int64

No comments found.

false

-

modifyTime

string

No comments found.

false

-

deleteFlag

int32

No comments found.

false

-

ignoreWarning

boolean

No comments found.

false

-

nullFields

array

No comments found.

false

-

changeLogId

int64

No comments found.

false

-

authTenantId

int64

授权租户数据

false

-

authType

string

授权模块 UDC 下拉选择项

false

-

Request-example:

curl -X PUT -H 'Content-Type: application/json' -H 'Authorization' -i /api/tenant/authTenant --data '{
  "id": 739,
  "remark": "m4ikyb",
  "createUserId": 358,
  "creator": "vy3wko",
  "createTime": "2023-09-27 17:34:57",
  "modifyUserId": 53,
  "modifyTime": "2023-09-27 17:34:57",
  "deleteFlag": 0,
  "ignoreWarning": true,
  "nullFields": [
    "552qrq"
  ],
  "changeLogId": 9,
  "authTenantId": 438,
  "authType": "2r3d44"
}'

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "3t2wpm",
      "defaultMsg": "ihsdtq",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "gw49yh",
      "defaultMsg": "14owee",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "gs06m7",
      "defaultMsg": "qv8t5t",
      "context": {
        "object": "any object"
      }
    }
  ]
}

2.3.主键查询

Type: GET

Author: duwh

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

Description: 主键查询

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Path-parameters:

ParameterTypeDescriptionRequiredSince

key

int64

关键

true

-

Request-example:

curl -X GET -H 'Authorization' -i /api/tenant/authTenant/467

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "tk3ujs",
      "defaultMsg": "vvduzd",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "4v383o",
      "defaultMsg": "x36v3w",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "4f29or",
      "defaultMsg": "ha583j",
      "context": {
        "object": "any object"
      }
    }
  ]
}

2.4.分页

Type: GET

Author: duwh

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

Description: 分页

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

current

int32

页码，默认为1

false

-

size

int32

页大小，默认为10

false

-

keyword

string

搜索关键字

false

-

idSet

object

ID

false

-

orders

array

排序

false

-

└─column

string

属性名称

false

-

└─asc

boolean

是否升序

false

-

remark

string

No comments found.

false

-

createUserId

int64

No comments found.

false

-

loginUserId

int64

登录用户id 用于数据权限

false

-

createTimeStart

string

No comments found.

false

-

createTimeEnd

string

No comments found.

false

-

modifyUserId

int64

No comments found.

false

-

modifyTimeStart

string

No comments found.

false

-

modifyTimeEnd

string

No comments found.

false

-

dataPermissionFlag

boolean

No comments found.

false

-

id

int64

记录唯一ID 精确

false

-

authTenantId

int64

授权租户数据 精确

false

-

authType

string

授权模块 UDC 下拉选择项 精确

false

-

Request-example:

curl -X GET -H 'Authorization' -i /api/tenant/authTenant/paging?current=427&size=10&keyword=4655pk&column=qplkeb&asc=true&remark=vvpouj&createUserId=64&loginUserId=785&createTimeStart=2023-09-27 17:34:57&createTimeEnd=2023-09-27 17:34:57&modifyUserId=29&modifyTimeStart=2023-09-27 17:34:57&modifyTimeEnd=2023-09-27 17:34:57&dataPermissionFlag=true&id=961&authTenantId=507&authType=krdu6v&orders[0].asc=true&orders[0].column=ekamtt

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "r9dp87",
      "defaultMsg": "bi1gdn",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "jysd2k",
      "defaultMsg": "at6qxq",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "kbq654",
      "defaultMsg": "q4jcjj",
      "context": {
        "object": "any object"
      }
    }
  ]
}

2.5.查询列表

Type: GET

Author: duwh

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

Description: 查询列表

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

current

int32

页码，默认为1

false

-

size

int32

页大小，默认为10

false

-

keyword

string

搜索关键字

false

-

idSet

object

ID

false

-

orders

array

排序

false

-

└─column

string

属性名称

false

-

└─asc

boolean

是否升序

false

-

remark

string

No comments found.

false

-

createUserId

int64

No comments found.

false

-

loginUserId

int64

登录用户id 用于数据权限

false

-

createTimeStart

string

No comments found.

false

-

createTimeEnd

string

No comments found.

false

-

modifyUserId

int64

No comments found.

false

-

modifyTimeStart

string

No comments found.

false

-

modifyTimeEnd

string

No comments found.

false

-

dataPermissionFlag

boolean

No comments found.

false

-

id

int64

记录唯一ID 精确

false

-

authTenantId

int64

授权租户数据 精确

false

-

authType

string

授权模块 UDC 下拉选择项 精确

false

-

Request-example:

curl -X GET -H 'Authorization' -i /api/tenant/authTenant/list?current=165&size=10&keyword=nmjyv9&column=t6vino&asc=true&remark=d3231s&createUserId=150&loginUserId=99&createTimeStart=2023-09-27 17:34:57&createTimeEnd=2023-09-27 17:34:57&modifyUserId=511&modifyTimeStart=2023-09-27 17:34:57&modifyTimeEnd=2023-09-27 17:34:57&dataPermissionFlag=true&id=154&authTenantId=230&authType=3o8flb&orders[0].asc=true&orders[0].column=waaomz

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "qky8c5",
      "defaultMsg": "2u5bll",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "c3gq1l",
      "defaultMsg": "ms2nyz",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "beste7",
      "defaultMsg": "2nfpxu",
      "context": {
        "object": "any object"
      }
    }
  ]
}

2.6.删除

Type: DELETE

Author: duwh

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

Description: 删除

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

keys

array

主键id,[array of int64]

false

-

Request-example:

curl -X DELETE -H 'Authorization' -i /api/tenant/authTenant/deleteSoft?keys=zdc8x4&keys=zdc8x4

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "jjdf9a",
      "defaultMsg": "ysvdwg",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "oyv1lq",
      "defaultMsg": "8duj6p",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "2vlqko",
      "defaultMsg": "h5tver",
      "context": {
        "object": "any object"
      }
    }
  ]
}

3.

3.1.查看对应新旧版本的变更

Type: GET

Author: liwenpeng

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

Description: 查看对应新旧版本的变更

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Path-parameters:

ParameterTypeDescriptionRequiredSince

logId

int64

No comments found.

true

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

compareLogId

int64

No comments found.

false

-

Request-example:

curl -X GET -H 'Authorization' -i /api/businessChange/changeLogDetail/498?compareLogId=554

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "ozr0j2",
      "defaultMsg": "fsbsi5",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "8deuww",
      "defaultMsg": "bi24j4",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "ph1f7j",
      "defaultMsg": "1hfs07",
      "context": {
        "object": "any object"
      }
    }
  ]
}

4.

4.1.变更历史

Type: POST

Author: carl

Content-Type: application/json

Description: 变更历史

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Body-parameters:

ParameterTypeDescriptionRequiredSince

current

int32

页码，默认为1

false

-

size

int32

页大小，默认为10

false

-

keyword

string

搜索关键字

false

-

idSet

object

ID

false

-

orders

array

排序

false

-

└─column

string

属性名称

false

-

└─asc

boolean

是否升序

false

-

id

int64

No comments found.

false

-

remark

string

No comments found.

false

-

createUserId

int64

No comments found.

false

-

loginUserId

int64

登录用户id 用于数据权限

false

-

createTimeStart

string

No comments found.

false

-

createTimeEnd

string

No comments found.

false

-

modifyUserId

int64

No comments found.

false

-

modifyTimeStart

string

No comments found.

false

-

modifyTimeEnd

string

No comments found.

false

-

dataPermissionFlag

boolean

No comments found.

false

-

changeType

string

变更类型

false

-

changeDocId

string

变更单据id

false

-

Request-example:

curl -X POST -H 'Content-Type: application/json' -H 'Authorization' -i /api/com/change/changeHistory --data '{
  "current": 145,
  "size": 10,
  "keyword": "6tcjvx",
  "idSet": {},
  "orders": [
    {
      "column": "r3rfjx",
      "asc": true
    }
  ],
  "id": 824,
  "remark": "dhdvef",
  "createUserId": 699,
  "loginUserId": 837,
  "createTimeStart": "2023-09-27 17:34:57",
  "createTimeEnd": "2023-09-27 17:34:57",
  "modifyUserId": 224,
  "modifyTimeStart": "2023-09-27 17:34:57",
  "modifyTimeEnd": "2023-09-27 17:34:57",
  "dataPermissionFlag": true,
  "changeType": "bwuy9t",
  "changeDocId": "196"
}'

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "vd5ymz",
      "defaultMsg": "bsy7xx",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "6wnsl6",
      "defaultMsg": "a2h8r2",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "l0hcfu",
      "defaultMsg": "etptuv",
      "context": {
        "object": "any object"
      }
    }
  ]
}

4.2.数据比对

Type: GET

Author: carl

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

Description: 数据比对

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

id

int64

比较目标值id

false

-

compareId

int64

比较值id

false

-

Request-example:

curl -X GET -H 'Authorization' -i /api/com/change/getCompareChange?id=434&compareId=608

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "7b49yi",
      "defaultMsg": "t4ucp0",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "g0iprk",
      "defaultMsg": "dkszjy",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "w2a2ut",
      "defaultMsg": "nt69u7",
      "context": {
        "object": "any object"
      }
    }
  ]
}

5.业务对象表

5.1.业务对象表-新增

Type: POST

Author: duwh

Content-Type: application/json

Description: 业务对象表-新增

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Body-parameters:

ParameterTypeDescriptionRequiredSince

id

int64

No comments found.

false

-

remark

string

No comments found.

false

-

createUserId

int64

No comments found.

false

-

creator

string

记录创建者

false

-

createTime

string

No comments found.

false

-

modifyUserId

int64

No comments found.

false

-

modifyTime

string

No comments found.

false

-

deleteFlag

int32

No comments found.

false

-

ignoreWarning

boolean

No comments found.

false

-

nullFields

array

No comments found.

false

-

changeLogId

int64

No comments found.

false

-

name

string

名称

false

-

tableName

string

数据库表名

false

-

type

string

业务关系 MIAN 主表 DETAIL 明细表

false

-

functionId

int64

功能主键 prd_system_function.id

false

-

enabled

boolean

是否启用

false

-

sortNo

int32

排序号

false

-

ext1

string

拓展字段1

false

-

ext2

string

拓展字段2

false

-

ext3

string

拓展字段3

false

-

Request-example:

curl -X POST -H 'Content-Type: application/json' -H 'Authorization' -i /api/common/funConfig/businessTable --data '{
  "id": 127,
  "remark": "fvfdfp",
  "createUserId": 622,
  "creator": "cv7aeu",
  "createTime": "2023-09-27 17:34:57",
  "modifyUserId": 856,
  "modifyTime": "2023-09-27 17:34:57",
  "deleteFlag": 0,
  "ignoreWarning": true,
  "nullFields": [
    "ikyh92"
  ],
  "changeLogId": 353,
  "name": "gil.paucek",
  "tableName": "gil.paucek",
  "type": "wb798o",
  "functionId": 223,
  "enabled": true,
  "sortNo": 834,
  "ext1": "45dzwa",
  "ext2": "dxzv05",
  "ext3": "clr02l"
}'

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

└─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

锁版本

-

└─name

string

名称

-

└─tableName

string

数据库表名

-

└─type

string

业务关系 MIAN 主表 DETAIL 明细表

-

└─functionId

int64

功能主键 prd_system_function.id

-

└─enabled

boolean

是否启用

-

└─sortNo

int32

排序号

-

└─ext1

string

拓展字段1

-

└─ext2

string

拓展字段2

-

└─ext3

string

拓展字段3

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {
    "id": 518,
    "tenantId": 103,
    "remark": "94tgl6",
    "createUserId": 406,
    "creator": "8d52nh",
    "createTime": "2023-09-27 17:34:57",
    "modifyUserId": 631,
    "updater": "b9suvm",
    "modifyTime": "2023-09-27 17:34:57",
    "deleteFlag": 0,
    "auditDataVersion": 419,
    "name": "gil.paucek",
    "tableName": "gil.paucek",
    "type": "qntypf",
    "functionId": 924,
    "enabled": true,
    "sortNo": 330,
    "ext1": "zdyzms",
    "ext2": "i5u2il",
    "ext3": "aw993z"
  },
  "infos": [
    {
      "localeCode": "88129",
      "msg": "f8b0iv",
      "defaultMsg": "kd654g",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "sz2lqa",
      "defaultMsg": "ngxmnt",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "gzekdj",
      "defaultMsg": "8la8lc",
      "context": {
        "object": "any object"
      }
    }
  ]
}

5.2.业务对象表-更新

Type: PUT

Author: duwh

Content-Type: application/json

Description: 业务对象表-更新

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Body-parameters:

ParameterTypeDescriptionRequiredSince

id

int64

No comments found.

false

-

remark

string

No comments found.

false

-

createUserId

int64

No comments found.

false

-

creator

string

记录创建者

false

-

createTime

string

No comments found.

false

-

modifyUserId

int64

No comments found.

false

-

modifyTime

string

No comments found.

false

-

deleteFlag

int32

No comments found.

false

-

ignoreWarning

boolean

No comments found.

false

-

nullFields

array

No comments found.

false

-

changeLogId

int64

No comments found.

false

-

name

string

名称

false

-

tableName

string

数据库表名

false

-

type

string

业务关系 MIAN 主表 DETAIL 明细表

false

-

functionId

int64

功能主键 prd_system_function.id

false

-

enabled

boolean

是否启用

false

-

sortNo

int32

排序号

false

-

ext1

string

拓展字段1

false

-

ext2

string

拓展字段2

false

-

ext3

string

拓展字段3

false

-

Request-example:

curl -X PUT -H 'Content-Type: application/json' -H 'Authorization' -i /api/common/funConfig/businessTable --data '{
  "id": 985,
  "remark": "gzcmti",
  "createUserId": 567,
  "creator": "526e54",
  "createTime": "2023-09-27 17:34:57",
  "modifyUserId": 980,
  "modifyTime": "2023-09-27 17:34:57",
  "deleteFlag": 0,
  "ignoreWarning": true,
  "nullFields": [
    "3esc3e"
  ],
  "changeLogId": 387,
  "name": "gil.paucek",
  "tableName": "gil.paucek",
  "type": "qfhaiy",
  "functionId": 378,
  "enabled": true,
  "sortNo": 846,
  "ext1": "70h7os",
  "ext2": "56tb54",
  "ext3": "8bszxd"
}'

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

└─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

锁版本

-

└─name

string

名称

-

└─tableName

string

数据库表名

-

└─type

string

业务关系 MIAN 主表 DETAIL 明细表

-

└─functionId

int64

功能主键 prd_system_function.id

-

└─enabled

boolean

是否启用

-

└─sortNo

int32

排序号

-

└─ext1

string

拓展字段1

-

└─ext2

string

拓展字段2

-

└─ext3

string

拓展字段3

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {
    "id": 711,
    "tenantId": 975,
    "remark": "7w8qr7",
    "createUserId": 157,
    "creator": "lp2vh6",
    "createTime": "2023-09-27 17:34:57",
    "modifyUserId": 734,
    "updater": "azztbj",
    "modifyTime": "2023-09-27 17:34:57",
    "deleteFlag": 0,
    "auditDataVersion": 849,
    "name": "gil.paucek",
    "tableName": "gil.paucek",
    "type": "jlt076",
    "functionId": 17,
    "enabled": true,
    "sortNo": 163,
    "ext1": "4w543n",
    "ext2": "cvpqf6",
    "ext3": "q24rmh"
  },
  "infos": [
    {
      "localeCode": "88129",
      "msg": "cfrcnh",
      "defaultMsg": "jcfg40",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "7i7w3f",
      "defaultMsg": "97bthm",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "52qo50",
      "defaultMsg": "rel2ug",
      "context": {
        "object": "any object"
      }
    }
  ]
}

5.3.业务对象表-更新,支持置空,置空的字段需需要借助 protected List<String> nullFields;

Type: PUT

Author: duwh

Content-Type: application/json

Description: 业务对象表-更新,支持置空,置空的字段需需要借助 protected List<String> nullFields;

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Body-parameters:

ParameterTypeDescriptionRequiredSince

id

int64

No comments found.

false

-

remark

string

No comments found.

false

-

createUserId

int64

No comments found.

false

-

creator

string

记录创建者

false

-

createTime

string

No comments found.

false

-

modifyUserId

int64

No comments found.

false

-

modifyTime

string

No comments found.

false

-

deleteFlag

int32

No comments found.

false

-

ignoreWarning

boolean

No comments found.

false

-

nullFields

array

No comments found.

false

-

changeLogId

int64

No comments found.

false

-

name

string

名称

false

-

tableName

string

数据库表名

false

-

type

string

业务关系 MIAN 主表 DETAIL 明细表

false

-

functionId

int64

功能主键 prd_system_function.id

false

-

enabled

boolean

是否启用

false

-

sortNo

int32

排序号

false

-

ext1

string

拓展字段1

false

-

ext2

string

拓展字段2

false

-

ext3

string

拓展字段3

false

-

Request-example:

curl -X PUT -H 'Content-Type: application/json' -H 'Authorization' -i /api/common/funConfig/businessTable/update --data '{
  "id": 599,
  "remark": "ylrty2",
  "createUserId": 246,
  "creator": "2yucml",
  "createTime": "2023-09-27 17:34:57",
  "modifyUserId": 391,
  "modifyTime": "2023-09-27 17:34:57",
  "deleteFlag": 0,
  "ignoreWarning": true,
  "nullFields": [
    "wcv0cw"
  ],
  "changeLogId": 794,
  "name": "gil.paucek",
  "tableName": "gil.paucek",
  "type": "rz34yi",
  "functionId": 248,
  "enabled": true,
  "sortNo": 473,
  "ext1": "kw6wpo",
  "ext2": "of1fz2",
  "ext3": "m536zq"
}'

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

int64

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": 460,
  "infos": [
    {
      "localeCode": "88129",
      "msg": "qb2ec9",
      "defaultMsg": "ymzelp",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "epg5vg",
      "defaultMsg": "7qcvqo",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "q2bj4p",
      "defaultMsg": "pgl3id",
      "context": {
        "object": "any object"
      }
    }
  ]
}

5.4.业务对象表-主键查询

Type: GET

Author: duwh

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

Description: 业务对象表-主键查询

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Path-parameters:

ParameterTypeDescriptionRequiredSince

key

int64

关键

true

-

Request-example:

curl -X GET -H 'Authorization' -i /api/common/funConfig/businessTable/943

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

└─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

锁版本

-

└─name

string

名称

-

└─tableName

string

数据库表名

-

└─type

string

业务关系 MIAN 主表 DETAIL 明细表

-

└─functionId

int64

功能主键 prd_system_function.id

-

└─enabled

boolean

是否启用

-

└─sortNo

int32

排序号

-

└─ext1

string

拓展字段1

-

└─ext2

string

拓展字段2

-

└─ext3

string

拓展字段3

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {
    "id": 933,
    "tenantId": 33,
    "remark": "tl3zad",
    "createUserId": 76,
    "creator": "qi9tbl",
    "createTime": "2023-09-27 17:34:57",
    "modifyUserId": 815,
    "updater": "i3mk7p",
    "modifyTime": "2023-09-27 17:34:57",
    "deleteFlag": 0,
    "auditDataVersion": 215,
    "name": "gil.paucek",
    "tableName": "gil.paucek",
    "type": "9vxrna",
    "functionId": 899,
    "enabled": true,
    "sortNo": 565,
    "ext1": "8qk3f7",
    "ext2": "5ey7l7",
    "ext3": "3alnv2"
  },
  "infos": [
    {
      "localeCode": "88129",
      "msg": "qc2f8s",
      "defaultMsg": "iwi096",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "sqep3a",
      "defaultMsg": "80qw0x",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "28m3vu",
      "defaultMsg": "2pya48",
      "context": {
        "object": "any object"
      }
    }
  ]
}

5.5.业务对象表-分页

Type: GET

Author: duwh

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

Description: 业务对象表-分页

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

current

int32

页码，默认为1

false

-

size

int32

页大小，默认为10

false

-

keyword

string

搜索关键字

false

-

idSet

object

ID

false

-

orders

array

排序

false

-

└─column

string

属性名称

false

-

└─asc

boolean

是否升序

false

-

remark

string

No comments found.

false

-

createUserId

int64

No comments found.

false

-

loginUserId

int64

登录用户id 用于数据权限

false

-

createTimeStart

string

No comments found.

false

-

createTimeEnd

string

No comments found.

false

-

modifyUserId

int64

No comments found.

false

-

modifyTimeStart

string

No comments found.

false

-

modifyTimeEnd

string

No comments found.

false

-

dataPermissionFlag

boolean

No comments found.

false

-

id

int64

记录唯一ID 精确

false

-

name

string

名称 精确

false

-

tableName

string

数据库表名 精确

false

-

type

string

业务关系 MIAN 主表 DETAIL 明细表 精确

false

-

functionId

int64

功能主键 prd_system_function.id 精确

false

-

enabled

boolean

是否启用 精确

false

-

sortNo

int32

排序号 精确

false

-

ext1

string

拓展字段1 精确

false

-

ext2

string

拓展字段2 精确

false

-

ext3

string

拓展字段3 精确

false

-

Request-example:

curl -X GET -H 'Authorization' -i /api/common/funConfig/businessTable/paging?current=669&size=10&keyword=09n6pl&column=vkhjys&asc=true&remark=s148w1&createUserId=482&loginUserId=342&createTimeStart=2023-09-27 17:34:57&createTimeEnd=2023-09-27 17:34:57&modifyUserId=530&modifyTimeStart=2023-09-27 17:34:57&modifyTimeEnd=2023-09-27 17:34:57&dataPermissionFlag=true&id=338&name=gil.paucek&tableName=gil.paucek&type=pbk750&functionId=136&enabled=true&sortNo=992&ext1=xlt1jc&ext2=8jysl9&ext3=4tnrc3&orders[0].column=q51rbr&orders[0].asc=true

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

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

锁版本

-

     └─name

string

名称

-

     └─tableName

string

数据库表名

-

     └─type

string

业务关系 MIAN 主表 DETAIL 明细表

-

     └─functionId

int64

功能主键 prd_system_function.id

-

     └─enabled

boolean

是否启用

-

     └─sortNo

int32

排序号

-

     └─ext1

string

拓展字段1

-

     └─ext2

string

拓展字段2

-

     └─ext3

string

拓展字段3

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {
    "total": 55,
    "records": [
      {
        "id": 596,
        "tenantId": 456,
        "remark": "2eec4q",
        "createUserId": 726,
        "creator": "600h6q",
        "createTime": "2023-09-27 17:34:57",
        "modifyUserId": 553,
        "updater": "9jjeqh",
        "modifyTime": "2023-09-27 17:34:57",
        "deleteFlag": 0,
        "auditDataVersion": 173,
        "name": "gil.paucek",
        "tableName": "gil.paucek",
        "type": "jyizjb",
        "functionId": 997,
        "enabled": true,
        "sortNo": 296,
        "ext1": "xr9oh4",
        "ext2": "n16l6x",
        "ext3": "4gw8ev"
      }
    ]
  },
  "infos": [
    {
      "localeCode": "88129",
      "msg": "m1svdc",
      "defaultMsg": "s4w5kj",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "hlsnxf",
      "defaultMsg": "f160t7",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "84fs4d",
      "defaultMsg": "76l2y6",
      "context": {
        "object": "any object"
      }
    }
  ]
}

5.6.业务对象表-查询列表

Type: GET

Author: duwh

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

Description: 业务对象表-查询列表

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

current

int32

页码，默认为1

false

-

size

int32

页大小，默认为10

false

-

keyword

string

搜索关键字

false

-

idSet

object

ID

false

-

orders

array

排序

false

-

└─column

string

属性名称

false

-

└─asc

boolean

是否升序

false

-

remark

string

No comments found.

false

-

createUserId

int64

No comments found.

false

-

loginUserId

int64

登录用户id 用于数据权限

false

-

createTimeStart

string

No comments found.

false

-

createTimeEnd

string

No comments found.

false

-

modifyUserId

int64

No comments found.

false

-

modifyTimeStart

string

No comments found.

false

-

modifyTimeEnd

string

No comments found.

false

-

dataPermissionFlag

boolean

No comments found.

false

-

id

int64

记录唯一ID 精确

false

-

name

string

名称 精确

false

-

tableName

string

数据库表名 精确

false

-

type

string

业务关系 MIAN 主表 DETAIL 明细表 精确

false

-

functionId

int64

功能主键 prd_system_function.id 精确

false

-

enabled

boolean

是否启用 精确

false

-

sortNo

int32

排序号 精确

false

-

ext1

string

拓展字段1 精确

false

-

ext2

string

拓展字段2 精确

false

-

ext3

string

拓展字段3 精确

false

-

Request-example:

curl -X GET -H 'Authorization' -i /api/common/funConfig/businessTable/list?current=683&size=10&keyword=38us2y&column=s3ypt4&asc=true&remark=jsyhpe&createUserId=214&loginUserId=963&createTimeStart=2023-09-27 17:34:57&createTimeEnd=2023-09-27 17:34:57&modifyUserId=237&modifyTimeStart=2023-09-27 17:34:57&modifyTimeEnd=2023-09-27 17:34:57&dataPermissionFlag=true&id=958&name=gil.paucek&tableName=gil.paucek&type=moxakt&functionId=503&enabled=true&sortNo=786&ext1=y1k8mw&ext2=kdkrgp&ext3=rddgya&orders[0].column=j309hm&orders[0].asc=true

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

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

锁版本

-

└─name

string

名称

-

└─tableName

string

数据库表名

-

└─type

string

业务关系 MIAN 主表 DETAIL 明细表

-

└─functionId

int64

功能主键 prd_system_function.id

-

└─enabled

boolean

是否启用

-

└─sortNo

int32

排序号

-

└─ext1

string

拓展字段1

-

└─ext2

string

拓展字段2

-

└─ext3

string

拓展字段3

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": [
    {
      "id": 593,
      "tenantId": 712,
      "remark": "l8wg7e",
      "createUserId": 119,
      "creator": "gmo8up",
      "createTime": "2023-09-27 17:34:57",
      "modifyUserId": 254,
      "updater": "xfdn9r",
      "modifyTime": "2023-09-27 17:34:57",
      "deleteFlag": 0,
      "auditDataVersion": 261,
      "name": "gil.paucek",
      "tableName": "gil.paucek",
      "type": "3cfedu",
      "functionId": 704,
      "enabled": true,
      "sortNo": 72,
      "ext1": "w3l4cl",
      "ext2": "rk6f6y",
      "ext3": "1f06e4"
    }
  ],
  "infos": [
    {
      "localeCode": "88129",
      "msg": "y0pffj",
      "defaultMsg": "boapk2",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "l8ibmg",
      "defaultMsg": "htwmvb",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "zlc4x7",
      "defaultMsg": "m3haee",
      "context": {
        "object": "any object"
      }
    }
  ]
}

5.7.业务对象表-删除

Type: DELETE

Author: duwh

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

Description: 业务对象表-删除

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

keys

array

主键id,[array of int64]

false

-

Request-example:

curl -X DELETE -H 'Authorization' -i /api/common/funConfig/businessTable/deleteSoft?keys=xuwwlb&keys=xuwwlb

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "ybn1t4",
      "defaultMsg": "fowuio",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "qot1rc",
      "defaultMsg": "j9p6kh",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "j476d8",
      "defaultMsg": "o3iltr",
      "context": {
        "object": "any object"
      }
    }
  ]
}

6.业务对象字段明细

6.1.业务对象字段明细-新增

Type: POST

Author: duwh

Content-Type: application/json

Description: 业务对象字段明细-新增

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Body-parameters:

ParameterTypeDescriptionRequiredSince

id

int64

No comments found.

false

-

remark

string

No comments found.

false

-

createUserId

int64

No comments found.

false

-

creator

string

记录创建者

false

-

createTime

string

No comments found.

false

-

modifyUserId

int64

No comments found.

false

-

modifyTime

string

No comments found.

false

-

deleteFlag

int32

No comments found.

false

-

ignoreWarning

boolean

No comments found.

false

-

nullFields

array

No comments found.

false

-

changeLogId

int64

No comments found.

false

-

tableId

string

业务对象主表主键 prd_business_table.id

false

-

field

string

字段

false

-

type

string

字段类型(数据库)

false

-

fieldKey

string

字段key

false

-

fieldName

string

字段名称

false

-

businessFlag

boolean

是否业务字段

false

-

notNull

boolean

是否必填

false

-

showName

string

显示名称

false

-

showType

string

业务类型 INPUT 文本输入 SELECT 选择器

false

-

showAttr

string

业务属性 JSON格式

false

-

defalutValue

string

默认值

false

-

regexVerify

string

正则验证

false

-

sortNo

int32

排序号

false

-

ext1

string

拓展字段1

false

-

ext2

string

拓展字段2

false

-

ext3

string

拓展字段3

false

-

Request-example:

curl -X POST -H 'Content-Type: application/json' -H 'Authorization' -i /api/common/funConfig/businessTableFields --data '{
  "id": 594,
  "remark": "v4t4vq",
  "createUserId": 382,
  "creator": "pqjro8",
  "createTime": "2023-09-27 17:34:57",
  "modifyUserId": 389,
  "modifyTime": "2023-09-27 17:34:57",
  "deleteFlag": 0,
  "ignoreWarning": true,
  "nullFields": [
    "79tstn"
  ],
  "changeLogId": 100,
  "tableId": "196",
  "field": "zp7lnh",
  "type": "3ye1k2",
  "fieldKey": "2evib4",
  "fieldName": "gil.paucek",
  "businessFlag": true,
  "notNull": true,
  "showName": "gil.paucek",
  "showType": "xs37cw",
  "showAttr": "fdqmql",
  "defalutValue": "judbfy",
  "regexVerify": "r09clz",
  "sortNo": 466,
  "ext1": "atyd3v",
  "ext2": "jmgv6e",
  "ext3": "xccxzh"
}'

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

└─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

锁版本

-

└─tableId

string

业务对象主表主键 prd_business_table.id

-

└─field

string

字段

-

└─type

string

字段类型(数据库)

-

└─fieldKey

string

字段key

-

└─fieldName

string

字段名称

-

└─businessFlag

boolean

是否业务字段

-

└─notNull

boolean

是否必填

-

└─showName

string

显示名称

-

└─showType

string

业务类型 INPUT 文本输入 SELECT 选择器

-

└─showAttr

string

业务属性 JSON格式

-

└─defalutValue

string

默认值

-

└─regexVerify

string

正则验证

-

└─sortNo

int32

排序号

-

└─ext1

string

拓展字段1

-

└─ext2

string

拓展字段2

-

└─ext3

string

拓展字段3

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {
    "id": 244,
    "tenantId": 97,
    "remark": "hx0mbr",
    "createUserId": 167,
    "creator": "d3tc0h",
    "createTime": "2023-09-27 17:34:57",
    "modifyUserId": 70,
    "updater": "y1adyw",
    "modifyTime": "2023-09-27 17:34:57",
    "deleteFlag": 0,
    "auditDataVersion": 846,
    "tableId": "196",
    "field": "m6s4v3",
    "type": "jo8p4h",
    "fieldKey": "ty8u91",
    "fieldName": "gil.paucek",
    "businessFlag": true,
    "notNull": true,
    "showName": "gil.paucek",
    "showType": "ugcvs1",
    "showAttr": "w04gng",
    "defalutValue": "ryo22f",
    "regexVerify": "b7msu8",
    "sortNo": 900,
    "ext1": "9390ps",
    "ext2": "2hefow",
    "ext3": "6u15bu"
  },
  "infos": [
    {
      "localeCode": "88129",
      "msg": "efbl2q",
      "defaultMsg": "9tbf4l",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "sg6zi4",
      "defaultMsg": "8gpl95",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "oz2jmg",
      "defaultMsg": "ihjjqd",
      "context": {
        "object": "any object"
      }
    }
  ]
}

6.2.业务对象字段明细-更新

Type: PUT

Author: duwh

Content-Type: application/json

Description: 业务对象字段明细-更新

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Body-parameters:

ParameterTypeDescriptionRequiredSince

id

int64

No comments found.

false

-

remark

string

No comments found.

false

-

createUserId

int64

No comments found.

false

-

creator

string

记录创建者

false

-

createTime

string

No comments found.

false

-

modifyUserId

int64

No comments found.

false

-

modifyTime

string

No comments found.

false

-

deleteFlag

int32

No comments found.

false

-

ignoreWarning

boolean

No comments found.

false

-

nullFields

array

No comments found.

false

-

changeLogId

int64

No comments found.

false

-

tableId

string

业务对象主表主键 prd_business_table.id

false

-

field

string

字段

false

-

type

string

字段类型(数据库)

false

-

fieldKey

string

字段key

false

-

fieldName

string

字段名称

false

-

businessFlag

boolean

是否业务字段

false

-

notNull

boolean

是否必填

false

-

showName

string

显示名称

false

-

showType

string

业务类型 INPUT 文本输入 SELECT 选择器

false

-

showAttr

string

业务属性 JSON格式

false

-

defalutValue

string

默认值

false

-

regexVerify

string

正则验证

false

-

sortNo

int32

排序号

false

-

ext1

string

拓展字段1

false

-

ext2

string

拓展字段2

false

-

ext3

string

拓展字段3

false

-

Request-example:

curl -X PUT -H 'Content-Type: application/json' -H 'Authorization' -i /api/common/funConfig/businessTableFields --data '{
  "id": 873,
  "remark": "jq49gq",
  "createUserId": 414,
  "creator": "php5ay",
  "createTime": "2023-09-27 17:34:57",
  "modifyUserId": 133,
  "modifyTime": "2023-09-27 17:34:57",
  "deleteFlag": 0,
  "ignoreWarning": true,
  "nullFields": [
    "3ga4v4"
  ],
  "changeLogId": 877,
  "tableId": "196",
  "field": "s4fsod",
  "type": "xosut9",
  "fieldKey": "sk1amy",
  "fieldName": "gil.paucek",
  "businessFlag": true,
  "notNull": true,
  "showName": "gil.paucek",
  "showType": "nh52b2",
  "showAttr": "0ls0v7",
  "defalutValue": "ilzrbf",
  "regexVerify": "urhehw",
  "sortNo": 850,
  "ext1": "ludlc5",
  "ext2": "i27jkf",
  "ext3": "yv0ujs"
}'

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

└─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

锁版本

-

└─tableId

string

业务对象主表主键 prd_business_table.id

-

└─field

string

字段

-

└─type

string

字段类型(数据库)

-

└─fieldKey

string

字段key

-

└─fieldName

string

字段名称

-

└─businessFlag

boolean

是否业务字段

-

└─notNull

boolean

是否必填

-

└─showName

string

显示名称

-

└─showType

string

业务类型 INPUT 文本输入 SELECT 选择器

-

└─showAttr

string

业务属性 JSON格式

-

└─defalutValue

string

默认值

-

└─regexVerify

string

正则验证

-

└─sortNo

int32

排序号

-

└─ext1

string

拓展字段1

-

└─ext2

string

拓展字段2

-

└─ext3

string

拓展字段3

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {
    "id": 975,
    "tenantId": 489,
    "remark": "21qfqb",
    "createUserId": 564,
    "creator": "9v2nbj",
    "createTime": "2023-09-27 17:34:57",
    "modifyUserId": 633,
    "updater": "mnrq9j",
    "modifyTime": "2023-09-27 17:34:57",
    "deleteFlag": 0,
    "auditDataVersion": 123,
    "tableId": "196",
    "field": "1fh1qe",
    "type": "rxzyfc",
    "fieldKey": "km6bzb",
    "fieldName": "gil.paucek",
    "businessFlag": true,
    "notNull": true,
    "showName": "gil.paucek",
    "showType": "hnu9rj",
    "showAttr": "o3qfu7",
    "defalutValue": "a5bz48",
    "regexVerify": "4z73n9",
    "sortNo": 224,
    "ext1": "iyn9ge",
    "ext2": "jy3hgn",
    "ext3": "txdu7b"
  },
  "infos": [
    {
      "localeCode": "88129",
      "msg": "ket31i",
      "defaultMsg": "56cpxu",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "a097cv",
      "defaultMsg": "ybvuef",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "wwoyy7",
      "defaultMsg": "rwno37",
      "context": {
        "object": "any object"
      }
    }
  ]
}

6.3.业务对象字段明细-更新,支持置空,置空的字段需需要借助 protected List<String> nullFields;

Type: PUT

Author: duwh

Content-Type: application/json

Description: 业务对象字段明细-更新,支持置空,置空的字段需需要借助 protected List<String> nullFields;

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Body-parameters:

ParameterTypeDescriptionRequiredSince

id

int64

No comments found.

false

-

remark

string

No comments found.

false

-

createUserId

int64

No comments found.

false

-

creator

string

记录创建者

false

-

createTime

string

No comments found.

false

-

modifyUserId

int64

No comments found.

false

-

modifyTime

string

No comments found.

false

-

deleteFlag

int32

No comments found.

false

-

ignoreWarning

boolean

No comments found.

false

-

nullFields

array

No comments found.

false

-

changeLogId

int64

No comments found.

false

-

tableId

string

业务对象主表主键 prd_business_table.id

false

-

field

string

字段

false

-

type

string

字段类型(数据库)

false

-

fieldKey

string

字段key

false

-

fieldName

string

字段名称

false

-

businessFlag

boolean

是否业务字段

false

-

notNull

boolean

是否必填

false

-

showName

string

显示名称

false

-

showType

string

业务类型 INPUT 文本输入 SELECT 选择器

false

-

showAttr

string

业务属性 JSON格式

false

-

defalutValue

string

默认值

false

-

regexVerify

string

正则验证

false

-

sortNo

int32

排序号

false

-

ext1

string

拓展字段1

false

-

ext2

string

拓展字段2

false

-

ext3

string

拓展字段3

false

-

Request-example:

curl -X PUT -H 'Content-Type: application/json' -H 'Authorization' -i /api/common/funConfig/businessTableFields/update --data '{
  "id": 180,
  "remark": "sibppx",
  "createUserId": 649,
  "creator": "y4juom",
  "createTime": "2023-09-27 17:34:57",
  "modifyUserId": 656,
  "modifyTime": "2023-09-27 17:34:57",
  "deleteFlag": 0,
  "ignoreWarning": true,
  "nullFields": [
    "ph1p1x"
  ],
  "changeLogId": 938,
  "tableId": "196",
  "field": "49o7pd",
  "type": "hbytcu",
  "fieldKey": "71m4r5",
  "fieldName": "gil.paucek",
  "businessFlag": true,
  "notNull": true,
  "showName": "gil.paucek",
  "showType": "6hb6ub",
  "showAttr": "jgkcub",
  "defalutValue": "1dttla",
  "regexVerify": "vy1po2",
  "sortNo": 919,
  "ext1": "fk8smc",
  "ext2": "lfy4dk",
  "ext3": "rnx170"
}'

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

int64

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": 327,
  "infos": [
    {
      "localeCode": "88129",
      "msg": "ge2twi",
      "defaultMsg": "479m8t",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "iux2po",
      "defaultMsg": "u7tiiu",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "osjf7j",
      "defaultMsg": "x3bg4e",
      "context": {
        "object": "any object"
      }
    }
  ]
}

6.4.业务对象字段明细-主键查询

Type: GET

Author: duwh

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

Description: 业务对象字段明细-主键查询

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Path-parameters:

ParameterTypeDescriptionRequiredSince

key

int64

关键

true

-

Request-example:

curl -X GET -H 'Authorization' -i /api/common/funConfig/businessTableFields/500

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

└─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

锁版本

-

└─tableId

string

业务对象主表主键 prd_business_table.id

-

└─field

string

字段

-

└─type

string

字段类型(数据库)

-

└─fieldKey

string

字段key

-

└─fieldName

string

字段名称

-

└─businessFlag

boolean

是否业务字段

-

└─notNull

boolean

是否必填

-

└─showName

string

显示名称

-

└─showType

string

业务类型 INPUT 文本输入 SELECT 选择器

-

└─showAttr

string

业务属性 JSON格式

-

└─defalutValue

string

默认值

-

└─regexVerify

string

正则验证

-

└─sortNo

int32

排序号

-

└─ext1

string

拓展字段1

-

└─ext2

string

拓展字段2

-

└─ext3

string

拓展字段3

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {
    "id": 536,
    "tenantId": 473,
    "remark": "evvuqn",
    "createUserId": 141,
    "creator": "p3ldyr",
    "createTime": "2023-09-27 17:34:57",
    "modifyUserId": 860,
    "updater": "ofc0rm",
    "modifyTime": "2023-09-27 17:34:57",
    "deleteFlag": 0,
    "auditDataVersion": 765,
    "tableId": "196",
    "field": "g0st2l",
    "type": "xa6eie",
    "fieldKey": "ibp1a5",
    "fieldName": "gil.paucek",
    "businessFlag": true,
    "notNull": true,
    "showName": "gil.paucek",
    "showType": "ev4mnd",
    "showAttr": "iemzd1",
    "defalutValue": "bfx3ty",
    "regexVerify": "xi2fa3",
    "sortNo": 272,
    "ext1": "6z42jn",
    "ext2": "2pva3g",
    "ext3": "2bfk0b"
  },
  "infos": [
    {
      "localeCode": "88129",
      "msg": "e4jsab",
      "defaultMsg": "bctn5l",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "lg1ms0",
      "defaultMsg": "ic9jsw",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "mseg0u",
      "defaultMsg": "m9flff",
      "context": {
        "object": "any object"
      }
    }
  ]
}

6.5.业务对象字段明细-分页

Type: GET

Author: duwh

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

Description: 业务对象字段明细-分页

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

current

int32

页码，默认为1

false

-

size

int32

页大小，默认为10

false

-

keyword

string

搜索关键字

false

-

idSet

object

ID

false

-

orders

array

排序

false

-

└─column

string

属性名称

false

-

└─asc

boolean

是否升序

false

-

remark

string

No comments found.

false

-

createUserId

int64

No comments found.

false

-

loginUserId

int64

登录用户id 用于数据权限

false

-

createTimeStart

string

No comments found.

false

-

createTimeEnd

string

No comments found.

false

-

modifyUserId

int64

No comments found.

false

-

modifyTimeStart

string

No comments found.

false

-

modifyTimeEnd

string

No comments found.

false

-

dataPermissionFlag

boolean

No comments found.

false

-

tableId

string

业务对象主表主键 prd_business_table.id

false

-

id

int64

记录唯一ID 精确

false

-

field

string

字段 精确

false

-

type

string

字段类型(数据库) 精确

false

-

fieldKey

string

字段key 精确

false

-

fieldName

string

字段名称 精确

false

-

businessFlag

boolean

是否业务字段 精确

false

-

notNull

boolean

是否必填 精确

false

-

showName

string

显示名称 精确

false

-

showType

string

业务类型 INPUT 文本输入 SELECT 选择器 精确

false

-

showAttr

string

业务属性 JSON格式 精确

false

-

defalutValue

string

默认值 精确

false

-

regexVerify

string

正则验证 精确

false

-

sortNo

int32

排序号 精确

false

-

ext1

string

拓展字段1 精确

false

-

ext2

string

拓展字段2 精确

false

-

ext3

string

拓展字段3 精确

false

-

Request-example:

curl -X GET -H 'Authorization' -i /api/common/funConfig/businessTableFields/paging?current=107&size=10&keyword=z5zkcq&column=roskdn&asc=true&remark=hi12o2&createUserId=290&loginUserId=348&createTimeStart=2023-09-27 17:34:57&createTimeEnd=2023-09-27 17:34:57&modifyUserId=637&modifyTimeStart=2023-09-27 17:34:57&modifyTimeEnd=2023-09-27 17:34:57&dataPermissionFlag=true&tableId=196&id=355&field=0vct0b&type=t9y9jq&fieldKey=se01mj&fieldName=gil.paucek&businessFlag=true¬Null=true&showName=gil.paucek&showType=vf8fg1&showAttr=zgzfw9&defalutValue=zh550q®exVerify=p6ihk1&sortNo=68&ext1=x0regr&ext2=u8cdfc&ext3=n6zu9p&orders[0].asc=true&orders[0].column=4yyx6w

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

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

锁版本

-

     └─tableId

string

业务对象主表主键 prd_business_table.id

-

     └─field

string

字段

-

     └─type

string

字段类型(数据库)

-

     └─fieldKey

string

字段key

-

     └─fieldName

string

字段名称

-

     └─businessFlag

boolean

是否业务字段

-

     └─notNull

boolean

是否必填

-

     └─showName

string

显示名称

-

     └─showType

string

业务类型 INPUT 文本输入 SELECT 选择器

-

     └─showAttr

string

业务属性 JSON格式

-

     └─defalutValue

string

默认值

-

     └─regexVerify

string

正则验证

-

     └─sortNo

int32

排序号

-

     └─ext1

string

拓展字段1

-

     └─ext2

string

拓展字段2

-

     └─ext3

string

拓展字段3

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {
    "total": 618,
    "records": [
      {
        "id": 202,
        "tenantId": 654,
        "remark": "c2yo7v",
        "createUserId": 399,
        "creator": "59g6yr",
        "createTime": "2023-09-27 17:34:57",
        "modifyUserId": 928,
        "updater": "essirs",
        "modifyTime": "2023-09-27 17:34:57",
        "deleteFlag": 0,
        "auditDataVersion": 616,
        "tableId": "196",
        "field": "t6i649",
        "type": "fuz155",
        "fieldKey": "dsz490",
        "fieldName": "gil.paucek",
        "businessFlag": true,
        "notNull": true,
        "showName": "gil.paucek",
        "showType": "0dck5w",
        "showAttr": "jw8hqx",
        "defalutValue": "vrrsee",
        "regexVerify": "v7tlku",
        "sortNo": 484,
        "ext1": "3o3br0",
        "ext2": "pjj3j7",
        "ext3": "lv1x5g"
      }
    ]
  },
  "infos": [
    {
      "localeCode": "88129",
      "msg": "e9w11g",
      "defaultMsg": "nvlfdg",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "30e5rg",
      "defaultMsg": "vhjtbq",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "x7txs3",
      "defaultMsg": "h6aalu",
      "context": {
        "object": "any object"
      }
    }
  ]
}

6.6.业务对象字段明细-查询列表

Type: GET

Author: duwh

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

Description: 业务对象字段明细-查询列表

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

current

int32

页码，默认为1

false

-

size

int32

页大小，默认为10

false

-

keyword

string

搜索关键字

false

-

idSet

object

ID

false

-

orders

array

排序

false

-

└─column

string

属性名称

false

-

└─asc

boolean

是否升序

false

-

remark

string

No comments found.

false

-

createUserId

int64

No comments found.

false

-

loginUserId

int64

登录用户id 用于数据权限

false

-

createTimeStart

string

No comments found.

false

-

createTimeEnd

string

No comments found.

false

-

modifyUserId

int64

No comments found.

false

-

modifyTimeStart

string

No comments found.

false

-

modifyTimeEnd

string

No comments found.

false

-

dataPermissionFlag

boolean

No comments found.

false

-

tableId

string

业务对象主表主键 prd_business_table.id

false

-

id

int64

记录唯一ID 精确

false

-

field

string

字段 精确

false

-

type

string

字段类型(数据库) 精确

false

-

fieldKey

string

字段key 精确

false

-

fieldName

string

字段名称 精确

false

-

businessFlag

boolean

是否业务字段 精确

false

-

notNull

boolean

是否必填 精确

false

-

showName

string

显示名称 精确

false

-

showType

string

业务类型 INPUT 文本输入 SELECT 选择器 精确

false

-

showAttr

string

业务属性 JSON格式 精确

false

-

defalutValue

string

默认值 精确

false

-

regexVerify

string

正则验证 精确

false

-

sortNo

int32

排序号 精确

false

-

ext1

string

拓展字段1 精确

false

-

ext2

string

拓展字段2 精确

false

-

ext3

string

拓展字段3 精确

false

-

Request-example:

curl -X GET -H 'Authorization' -i /api/common/funConfig/businessTableFields/list?current=244&size=10&keyword=l5au6i&column=jhrkp4&asc=true&remark=uo55nb&createUserId=520&loginUserId=296&createTimeStart=2023-09-27 17:34:57&createTimeEnd=2023-09-27 17:34:57&modifyUserId=566&modifyTimeStart=2023-09-27 17:34:57&modifyTimeEnd=2023-09-27 17:34:57&dataPermissionFlag=true&tableId=196&id=808&field=b69edj&type=p5g06x&fieldKey=yae9hq&fieldName=gil.paucek&businessFlag=true¬Null=true&showName=gil.paucek&showType=dxbrya&showAttr=3vgfpk&defalutValue=xc7xy6®exVerify=ctupjk&sortNo=431&ext1=q8a2nb&ext2=lgxe7q&ext3=g7dmb3&orders[0].asc=true&orders[0].column=qdpwt5

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

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

锁版本

-

└─tableId

string

业务对象主表主键 prd_business_table.id

-

└─field

string

字段

-

└─type

string

字段类型(数据库)

-

└─fieldKey

string

字段key

-

└─fieldName

string

字段名称

-

└─businessFlag

boolean

是否业务字段

-

└─notNull

boolean

是否必填

-

└─showName

string

显示名称

-

└─showType

string

业务类型 INPUT 文本输入 SELECT 选择器

-

└─showAttr

string

业务属性 JSON格式

-

└─defalutValue

string

默认值

-

└─regexVerify

string

正则验证

-

└─sortNo

int32

排序号

-

└─ext1

string

拓展字段1

-

└─ext2

string

拓展字段2

-

└─ext3

string

拓展字段3

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": [
    {
      "id": 644,
      "tenantId": 229,
      "remark": "gftorx",
      "createUserId": 93,
      "creator": "xfvhyt",
      "createTime": "2023-09-27 17:34:57",
      "modifyUserId": 164,
      "updater": "t3qaz6",
      "modifyTime": "2023-09-27 17:34:57",
      "deleteFlag": 0,
      "auditDataVersion": 629,
      "tableId": "196",
      "field": "cvlsfa",
      "type": "bu43ma",
      "fieldKey": "y5vwhv",
      "fieldName": "gil.paucek",
      "businessFlag": true,
      "notNull": true,
      "showName": "gil.paucek",
      "showType": "18zn9t",
      "showAttr": "bwkcfe",
      "defalutValue": "7g4czw",
      "regexVerify": "pmtgsl",
      "sortNo": 479,
      "ext1": "met3pe",
      "ext2": "mfhoam",
      "ext3": "m4y3mm"
    }
  ],
  "infos": [
    {
      "localeCode": "88129",
      "msg": "wwfvaq",
      "defaultMsg": "tm1mio",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "1xbhlx",
      "defaultMsg": "rrbjk2",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "qmln84",
      "defaultMsg": "gbbf0n",
      "context": {
        "object": "any object"
      }
    }
  ]
}

6.7.业务对象字段明细-删除

Type: DELETE

Author: duwh

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

Description: 业务对象字段明细-删除

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

keys

array

主键id,[array of int64]

false

-

Request-example:

curl -X DELETE -H 'Authorization' -i /api/common/funConfig/businessTableFields/deleteSoft?keys=34oeih&keys=34oeih

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "v91w1j",
      "defaultMsg": "m3ljsm",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "8q2w6v",
      "defaultMsg": "37awxo",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "adh5z5",
      "defaultMsg": "n55k4i",
      "context": {
        "object": "any object"
      }
    }
  ]
}

7.

7.1.分页

Type: GET

Author: carl

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

Description: 分页

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

current

int32

页码，默认为1

false

-

size

int32

页大小，默认为10

false

-

keyword

string

搜索关键字

false

-

idSet

object

ID

false

-

orders

array

排序

false

-

└─column

string

属性名称

false

-

└─asc

boolean

是否升序

false

-

id

int64

No comments found.

false

-

remark

string

No comments found.

false

-

createUserId

int64

No comments found.

false

-

loginUserId

int64

登录用户id 用于数据权限

false

-

createTimeStart

string

No comments found.

false

-

createTimeEnd

string

No comments found.

false

-

modifyUserId

int64

No comments found.

false

-

modifyTimeStart

string

No comments found.

false

-

modifyTimeEnd

string

No comments found.

false

-

dataPermissionFlag

boolean

No comments found.

false

-

objectId

string

对象id

false

-

logType

string

跟进对象

false

-

versionNo

int32

版本号

false

-

logContent

string

日志内容

false

-

extString1

string

No comments found.

false

-

extString2

string

No comments found.

false

-

extString3

string

No comments found.

false

-

extString4

string

No comments found.

false

-

extString5

string

No comments found.

false

-

Request-example:

curl -X GET -H 'Authorization' -i /api/com/log/paging?current=285&size=10&keyword=l2m99b&column=6v5wth&asc=true&id=195&remark=oyelux&createUserId=931&loginUserId=670&createTimeStart=2023-09-27 17:34:57&createTimeEnd=2023-09-27 17:34:57&modifyUserId=519&modifyTimeStart=2023-09-27 17:34:57&modifyTimeEnd=2023-09-27 17:34:57&dataPermissionFlag=true&objectId=196&logType=h3hos3&versionNo=178&logContent=2i8q8m&extString1=rpjd00&extString2=uw0hjd&extString3=fkku38&extString4=yizgy2&extString5=acwwv3&orders[0].column=a32ad7&orders[0].asc=true

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "t6x5tl",
      "defaultMsg": "fi3qji",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "p204n7",
      "defaultMsg": "je3776",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "38dr8e",
      "defaultMsg": "7s78n2",
      "context": {
        "object": "any object"
      }
    }
  ]
}

7.2.查询列表

Type: GET

Author: carl

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

Description: 查询列表

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

current

int32

页码，默认为1

false

-

size

int32

页大小，默认为10

false

-

keyword

string

搜索关键字

false

-

idSet

object

ID

false

-

orders

array

排序

false

-

└─column

string

属性名称

false

-

└─asc

boolean

是否升序

false

-

id

int64

No comments found.

false

-

remark

string

No comments found.

false

-

createUserId

int64

No comments found.

false

-

loginUserId

int64

登录用户id 用于数据权限

false

-

createTimeStart

string

No comments found.

false

-

createTimeEnd

string

No comments found.

false

-

modifyUserId

int64

No comments found.

false

-

modifyTimeStart

string

No comments found.

false

-

modifyTimeEnd

string

No comments found.

false

-

dataPermissionFlag

boolean

No comments found.

false

-

objectId

string

对象id

false

-

logType

string

跟进对象

false

-

versionNo

int32

版本号

false

-

logContent

string

日志内容

false

-

extString1

string

No comments found.

false

-

extString2

string

No comments found.

false

-

extString3

string

No comments found.

false

-

extString4

string

No comments found.

false

-

extString5

string

No comments found.

false

-

Request-example:

curl -X GET -H 'Authorization' -i /api/com/log/list?current=33&size=10&keyword=y7tor7&column=uhxaow&asc=true&id=754&remark=3k1sjf&createUserId=562&loginUserId=426&createTimeStart=2023-09-27 17:34:57&createTimeEnd=2023-09-27 17:34:57&modifyUserId=639&modifyTimeStart=2023-09-27 17:34:57&modifyTimeEnd=2023-09-27 17:34:57&dataPermissionFlag=true&objectId=196&logType=p6i6lu&versionNo=984&logContent=pcglov&extString1=48pzu5&extString2=0ip0sy&extString3=1rrwug&extString4=ofr00f&extString5=b191ne&orders[0].asc=true&orders[0].column=jig704

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "on9r1m",
      "defaultMsg": "hshwqr",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "c50qdl",
      "defaultMsg": "anzr42",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "2uitjt",
      "defaultMsg": "f74qxg",
      "context": {
        "object": "any object"
      }
    }
  ]
}

7.3.主键查询

Type: GET

Author: carl

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

Description: 主键查询

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Path-parameters:

ParameterTypeDescriptionRequiredSince

key

int64

关键

true

-

Request-example:

curl -X GET -H 'Authorization' -i /api/com/log/236

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "k56d5x",
      "defaultMsg": "x9bdie",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "3vw8i4",
      "defaultMsg": "oq43bo",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "t3wguo",
      "defaultMsg": "hut5rj",
      "context": {
        "object": "any object"
      }
    }
  ]
}

8.

8.1.

Type: GET

Author: zoey

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

Description: 

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

msg_signature

string

No comments found.

true

-

timestamp

string

No comments found.

true

-

nonce

string

No comments found.

true

-

echostr

string

No comments found.

true

-

Request-example:

curl -X GET -H 'Authorization' -i /api/qywx/telework?msg_signature=prxxop×tamp=2023-09-27 17:34:56&nonce=dtxhf4&echostr=yc9vd1 --data '&prxxop&2023-09-27 17:34:56&dtxhf4&yc9vd1'

Response-example:

string

8.2.

Type: POST

Author: zoey

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

Description: 

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

msg_signature

string

No comments found.

true

-

timestamp

string

No comments found.

true

-

nonce

string

No comments found.

true

-

Request-example:

curl -X POST -H 'Authorization' -i /api/qywx/telework --data 'msg_signature=rlrrnt×tamp=2023-09-27 17:34:56&nonce=6mmkj3'

Response-example:

string

8.3.验证签名

Type: GET

Author: zoey

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

Description: 验证签名

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

msg_signature

string

No comments found.

true

-

timestamp

string

No comments found.

true

-

nonce

string

No comments found.

true

-

echostr

string

No comments found.

true

-

Request-example:

curl -X GET -H 'Authorization' -i /api/qywx/schedule?msg_signature=a3ejp7×tamp=2023-09-27 17:34:56&nonce=wce9kf&echostr=01im6l --data '&a3ejp7&2023-09-27 17:34:56&wce9kf&01im6l'

Response-example:

string

8.4.接收用户消息并解密

Type: POST

Author: zoey

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

Description: 接收用户消息并解密

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

msg_signature

string

No comments found.

true

-

timestamp

string

No comments found.

true

-

nonce

string

No comments found.

true

-

Request-example:

curl -X POST -H 'Authorization' -i /api/qywx/schedule --data 'msg_signature=71dja1×tamp=2023-09-27 17:34:56&nonce=8pgrvo'

Response-example:

string

8.5.手机号查询用户id

Type: GET

Author: zoey

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

Description: 手机号查询用户id

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Request-example:

curl -X GET -H 'Authorization' -i /api/qywx/queryId

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "kzy3rd",
      "defaultMsg": "aae6tr",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "z9rsz9",
      "defaultMsg": "58g4gx",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "kee32u",
      "defaultMsg": "n2tor5",
      "context": {
        "object": "any object"
      }
    }
  ]
}

8.6.发送下载用户请求

Type: GET

Author: zoey

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

Description: 发送下载用户请求

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Request-example:

curl -X GET -H 'Authorization' -i /api/qywx/exportUsersRequest

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "ipiycr",
      "defaultMsg": "knhwut",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "3s9rfe",
      "defaultMsg": "wtd9sr",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "vkt2zg",
      "defaultMsg": "sx7665",
      "context": {
        "object": "any object"
      }
    }
  ]
}

8.7.执行下载

Type: GET

Author: zoey

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

Description: 执行下载

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Request-example:

curl -X GET -H 'Authorization' -i /api/qywx/exportUsersExport

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "zdbs4t",
      "defaultMsg": "h7y0vm",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "61njtc",
      "defaultMsg": "40uf51",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "yfkyib",
      "defaultMsg": "rb84v2",
      "context": {
        "object": "any object"
      }
    }
  ]
}

9.合同模板控制器

9.1.新增

Type: POST

Author: duwh

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

Description: 新增

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

id

int64

No comments found.

false

-

remark

string

No comments found.

false

-

createUserId

int64

No comments found.

false

-

creator

string

记录创建者

false

-

createTime

string

No comments found.

false

-

modifyUserId

int64

No comments found.

false

-

modifyTime

string

No comments found.

false

-

deleteFlag

int32

No comments found.

false

-

ignoreWarning

boolean

No comments found.

false

-

nullFields

array

No comments found.

false

-

changeLogId

int64

No comments found.

false

-

categoryId

int64

类别id

false

-

tagId

int64

标签id

false

-

name

string

名称

false

-

tempNo

string

编号

false

-

thumbnail

string

缩略图

false

-

hiddenFlag

int32

隐藏标志 0：不隐藏，1：隐藏

false

-

sortNo

int32

排序

false

-

Request-example:

curl -X POST -H 'Authorization' -i /api/sale/contractTemp --data 'id=29&remark=xfcgcn&createUserId=922&creator=wsau56&createTime=2023-09-27 17:34:57&modifyUserId=192&modifyTime=2023-09-27 17:34:57&deleteFlag=0&ignoreWarning=true&nullFields=6obn9i,6obn9i&changeLogId=160&categoryId=908&tagId=484&name=gil.paucek&tempNo=t1c910&thumbnail=ko6ud2&hiddenFlag=0&sortNo=665'

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "grehk5",
      "defaultMsg": "02nkfq",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "nurcpx",
      "defaultMsg": "6i2lim",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "91tpyb",
      "defaultMsg": "ud2es4",
      "context": {
        "object": "any object"
      }
    }
  ]
}

9.2.更新

Type: PUT

Author: duwh

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

Description: 更新

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

id

int64

No comments found.

false

-

remark

string

No comments found.

false

-

createUserId

int64

No comments found.

false

-

creator

string

记录创建者

false

-

createTime

string

No comments found.

false

-

modifyUserId

int64

No comments found.

false

-

modifyTime

string

No comments found.

false

-

deleteFlag

int32

No comments found.

false

-

ignoreWarning

boolean

No comments found.

false

-

nullFields

array

No comments found.

false

-

changeLogId

int64

No comments found.

false

-

categoryId

int64

类别id

false

-

tagId

int64

标签id

false

-

name

string

名称

false

-

tempNo

string

编号

false

-

thumbnail

string

缩略图

false

-

hiddenFlag

int32

隐藏标志 0：不隐藏，1：隐藏

false

-

sortNo

int32

排序

false

-

Request-example:

curl -X PUT -H 'Authorization' -i /api/sale/contractTemp --data 'id=718&remark=q4hr4t&createUserId=485&creator=pkgi5o&createTime=2023-09-27 17:34:57&modifyUserId=77&modifyTime=2023-09-27 17:34:57&deleteFlag=0&ignoreWarning=true&nullFields=ypjrst,ypjrst&changeLogId=733&categoryId=902&tagId=236&name=gil.paucek&tempNo=n22kh7&thumbnail=n0e5ip&hiddenFlag=0&sortNo=340'

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "qeckmb",
      "defaultMsg": "8qaats",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "t4oe7q",
      "defaultMsg": "pc5888",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "xr2enu",
      "defaultMsg": "et4t5j",
      "context": {
        "object": "any object"
      }
    }
  ]
}

9.3.主键查询

Type: GET

Author: duwh

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

Description: 主键查询

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Path-parameters:

ParameterTypeDescriptionRequiredSince

key

int64

关键

true

-

Request-example:

curl -X GET -H 'Authorization' -i /api/sale/contractTemp/882

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "uc3t70",
      "defaultMsg": "6udr8r",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "w5xpt9",
      "defaultMsg": "1doisv",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "c1gbok",
      "defaultMsg": "3w1t2a",
      "context": {
        "object": "any object"
      }
    }
  ]
}

9.4.分页

Type: GET

Author: duwh

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

Description: 分页

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

current

int32

页码，默认为1

false

-

size

int32

页大小，默认为10

false

-

keyword

string

搜索关键字

false

-

idSet

object

ID

false

-

orders

array

排序

false

-

└─column

string

属性名称

false

-

└─asc

boolean

是否升序

false

-

id

int64

No comments found.

false

-

remark

string

No comments found.

false

-

createUserId

int64

No comments found.

false

-

loginUserId

int64

登录用户id 用于数据权限

false

-

createTimeStart

string

No comments found.

false

-

createTimeEnd

string

No comments found.

false

-

modifyUserId

int64

No comments found.

false

-

modifyTimeStart

string

No comments found.

false

-

modifyTimeEnd

string

No comments found.

false

-

dataPermissionFlag

boolean

No comments found.

false

-

categoryId

int64

类别id

false

-

tagId

int64

标签id

false

-

name

string

名称

false

-

tempNo

string

编号

false

-

thumbnail

string

缩略图

false

-

hiddenFlag

int32

隐藏标志 0：不隐藏，1：隐藏

false

-

sortNo

int32

排序

false

-

Request-example:

curl -X GET -H 'Authorization' -i /api/sale/contractTemp/paging?current=101&size=10&keyword=eleb8q&column=hsnu0u&asc=true&id=619&remark=bmd53s&createUserId=812&loginUserId=30&createTimeStart=2023-09-27 17:34:57&createTimeEnd=2023-09-27 17:34:57&modifyUserId=923&modifyTimeStart=2023-09-27 17:34:57&modifyTimeEnd=2023-09-27 17:34:57&dataPermissionFlag=true&categoryId=444&tagId=478&name=gil.paucek&tempNo=95hqm0&thumbnail=x98w9b&hiddenFlag=0&sortNo=467&orders[0].asc=true&orders[0].column=le5wyl

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "ulepr1",
      "defaultMsg": "bmdvw6",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "aabqjd",
      "defaultMsg": "s3fbnp",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "y5ix9r",
      "defaultMsg": "29z4ew",
      "context": {
        "object": "any object"
      }
    }
  ]
}

9.5.查询列表

Type: GET

Author: duwh

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

Description: 查询列表

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

current

int32

页码，默认为1

false

-

size

int32

页大小，默认为10

false

-

keyword

string

搜索关键字

false

-

idSet

object

ID

false

-

orders

array

排序

false

-

└─column

string

属性名称

false

-

└─asc

boolean

是否升序

false

-

id

int64

No comments found.

false

-

remark

string

No comments found.

false

-

createUserId

int64

No comments found.

false

-

loginUserId

int64

登录用户id 用于数据权限

false

-

createTimeStart

string

No comments found.

false

-

createTimeEnd

string

No comments found.

false

-

modifyUserId

int64

No comments found.

false

-

modifyTimeStart

string

No comments found.

false

-

modifyTimeEnd

string

No comments found.

false

-

dataPermissionFlag

boolean

No comments found.

false

-

categoryId

int64

类别id

false

-

tagId

int64

标签id

false

-

name

string

名称

false

-

tempNo

string

编号

false

-

thumbnail

string

缩略图

false

-

hiddenFlag

int32

隐藏标志 0：不隐藏，1：隐藏

false

-

sortNo

int32

排序

false

-

Request-example:

curl -X GET -H 'Authorization' -i /api/sale/contractTemp/list?current=386&size=10&keyword=mu9hce&column=zglwvo&asc=true&id=659&remark=huwjq4&createUserId=928&loginUserId=354&createTimeStart=2023-09-27 17:34:57&createTimeEnd=2023-09-27 17:34:57&modifyUserId=471&modifyTimeStart=2023-09-27 17:34:57&modifyTimeEnd=2023-09-27 17:34:57&dataPermissionFlag=true&categoryId=716&tagId=546&name=gil.paucek&tempNo=nsjssa&thumbnail=beebu4&hiddenFlag=0&sortNo=303&orders[0].column=rfu2hj&orders[0].asc=true

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "u616ew",
      "defaultMsg": "c83wks",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "e2ed1l",
      "defaultMsg": "f5uutz",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "i2dx61",
      "defaultMsg": "rkej1r",
      "context": {
        "object": "any object"
      }
    }
  ]
}

9.6.删除

Type: DELETE

Author: duwh

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

Description: 删除

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

keys

array

主键id,[array of int64]

false

-

Request-example:

curl -X DELETE -H 'Authorization' -i /api/sale/contractTemp/deleteSoft?keys=8xjcup&keys=8xjcup

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "tzjr3i",
      "defaultMsg": "kvbr4a",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "lcgra6",
      "defaultMsg": "yeefnu",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "pgf9lp",
      "defaultMsg": "5bizg3",
      "context": {
        "object": "any object"
      }
    }
  ]
}

10.合同控制器

10.1.新增

Type: POST

Author: duwh

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

Description: 新增

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

id

int64

No comments found.

false

-

remark

string

No comments found.

false

-

createUserId

int64

No comments found.

false

-

creator

string

记录创建者

false

-

createTime

string

No comments found.

false

-

modifyUserId

int64

No comments found.

false

-

modifyTime

string

No comments found.

false

-

deleteFlag

int32

No comments found.

false

-

ignoreWarning

boolean

No comments found.

false

-

nullFields

array

No comments found.

false

-

changeLogId

int64

No comments found.

false

-

tempId

int64

模板主键

false

-

tagId

int64

标签id

false

-

contractName

string

合同名称

false

-

contractNo

string

合同编号

false

-

amt

number

合同金额

false

-

contractStatus

string

合同状态

false

-

contractDesc

string

合同描述

false

-

procInstId

string

流程实例ID

false

-

procInstStatus

object

流程审批状态

false

-

submitTime

string

提交时间

false

-

approvedTime

string

审批时间

false

-

Request-example:

curl -X POST -H 'Authorization' -i /api/sale/contract --data 'id=401&remark=o6lfst&createUserId=86&creator=hkr59d&createTime=2023-09-27 17:34:57&modifyUserId=276&modifyTime=2023-09-27 17:34:57&deleteFlag=0&ignoreWarning=true&nullFields=ndjl3j,ndjl3j&changeLogId=788&tempId=21&tagId=371&contractName=gil.paucek&contractNo=mff5oe&amt=73&contractStatus=jad3al&contractDesc=2ix4zg&procInstId=196&submitTime=2023-09-27 17:34:57&approvedTime=2023-09-27 17:34:57'

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "unf15f",
      "defaultMsg": "0blxk3",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "atl93r",
      "defaultMsg": "rx6wo2",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "3byqmg",
      "defaultMsg": "5phnrr",
      "context": {
        "object": "any object"
      }
    }
  ]
}

10.2.更新

Type: PUT

Author: duwh

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

Description: 更新

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

id

int64

No comments found.

false

-

remark

string

No comments found.

false

-

createUserId

int64

No comments found.

false

-

creator

string

记录创建者

false

-

createTime

string

No comments found.

false

-

modifyUserId

int64

No comments found.

false

-

modifyTime

string

No comments found.

false

-

deleteFlag

int32

No comments found.

false

-

ignoreWarning

boolean

No comments found.

false

-

nullFields

array

No comments found.

false

-

changeLogId

int64

No comments found.

false

-

tempId

int64

模板主键

false

-

tagId

int64

标签id

false

-

contractName

string

合同名称

false

-

contractNo

string

合同编号

false

-

amt

number

合同金额

false

-

contractStatus

string

合同状态

false

-

contractDesc

string

合同描述

false

-

procInstId

string

流程实例ID

false

-

procInstStatus

object

流程审批状态

false

-

submitTime

string

提交时间

false

-

approvedTime

string

审批时间

false

-

Request-example:

curl -X PUT -H 'Authorization' -i /api/sale/contract --data 'id=801&remark=m73a0u&createUserId=127&creator=5f4opb&createTime=2023-09-27 17:34:57&modifyUserId=430&modifyTime=2023-09-27 17:34:57&deleteFlag=0&ignoreWarning=true&nullFields=03kbsp,03kbsp&changeLogId=121&tempId=365&tagId=633&contractName=gil.paucek&contractNo=3kasrq&amt=452&contractStatus=dviicy&contractDesc=gs7iau&procInstId=196&submitTime=2023-09-27 17:34:57&approvedTime=2023-09-27 17:34:57'

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "u5zvjt",
      "defaultMsg": "lba2k4",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "nv4odo",
      "defaultMsg": "1ptaur",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "cy7ced",
      "defaultMsg": "0b4xfv",
      "context": {
        "object": "any object"
      }
    }
  ]
}

10.3.主键查询

Type: GET

Author: duwh

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

Description: 主键查询

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Path-parameters:

ParameterTypeDescriptionRequiredSince

key

int64

关键

true

-

Request-example:

curl -X GET -H 'Authorization' -i /api/sale/contract/720

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "et69k7",
      "defaultMsg": "jrrhb0",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "hzjlbc",
      "defaultMsg": "eyo4mg",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "56t227",
      "defaultMsg": "8p3qtk",
      "context": {
        "object": "any object"
      }
    }
  ]
}

10.4.分页

Type: GET

Author: duwh

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

Description: 分页

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

current

int32

页码，默认为1

false

-

size

int32

页大小，默认为10

false

-

keyword

string

搜索关键字

false

-

idSet

object

ID

false

-

orders

array

排序

false

-

└─column

string

属性名称

false

-

└─asc

boolean

是否升序

false

-

id

int64

No comments found.

false

-

remark

string

No comments found.

false

-

createUserId

int64

No comments found.

false

-

loginUserId

int64

登录用户id 用于数据权限

false

-

createTimeStart

string

No comments found.

false

-

createTimeEnd

string

No comments found.

false

-

modifyUserId

int64

No comments found.

false

-

modifyTimeStart

string

No comments found.

false

-

modifyTimeEnd

string

No comments found.

false

-

dataPermissionFlag

boolean

No comments found.

false

-

tempId

int64

模板主键

false

-

tagId

int64

标签id

false

-

contractName

string

合同名称

false

-

contractNo

string

合同编号

false

-

amt

number

合同金额

false

-

contractStatus

string

合同状态

false

-

contractDesc

string

合同描述

false

-

procInstId

string

流程实例ID

false

-

procInstStatus

object

流程审批状态

false

-

submitTime

string

提交时间

false

-

approvedTime

string

审批时间

false

-

Request-example:

curl -X GET -H 'Authorization' -i /api/sale/contract/paging?current=910&size=10&keyword=l6aasr&column=4a9hr9&asc=true&id=773&remark=5w2mxn&createUserId=158&loginUserId=671&createTimeStart=2023-09-27 17:34:57&createTimeEnd=2023-09-27 17:34:57&modifyUserId=818&modifyTimeStart=2023-09-27 17:34:57&modifyTimeEnd=2023-09-27 17:34:57&dataPermissionFlag=true&tempId=740&tagId=892&contractName=gil.paucek&contractNo=clotf6&amt=475&contractStatus=plm4gd&contractDesc=ltz0fz&procInstId=196&submitTime=2023-09-27 17:34:57&approvedTime=2023-09-27 17:34:57&orders[0].column=5h6kjj&orders[0].asc=true

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "mdux2p",
      "defaultMsg": "65xodr",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "cp8kgr",
      "defaultMsg": "pjs0hf",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "3uez76",
      "defaultMsg": "eom0op",
      "context": {
        "object": "any object"
      }
    }
  ]
}

10.5.查询列表

Type: GET

Author: duwh

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

Description: 查询列表

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

current

int32

页码，默认为1

false

-

size

int32

页大小，默认为10

false

-

keyword

string

搜索关键字

false

-

idSet

object

ID

false

-

orders

array

排序

false

-

└─column

string

属性名称

false

-

└─asc

boolean

是否升序

false

-

id

int64

No comments found.

false

-

remark

string

No comments found.

false

-

createUserId

int64

No comments found.

false

-

loginUserId

int64

登录用户id 用于数据权限

false

-

createTimeStart

string

No comments found.

false

-

createTimeEnd

string

No comments found.

false

-

modifyUserId

int64

No comments found.

false

-

modifyTimeStart

string

No comments found.

false

-

modifyTimeEnd

string

No comments found.

false

-

dataPermissionFlag

boolean

No comments found.

false

-

tempId

int64

模板主键

false

-

tagId

int64

标签id

false

-

contractName

string

合同名称

false

-

contractNo

string

合同编号

false

-

amt

number

合同金额

false

-

contractStatus

string

合同状态

false

-

contractDesc

string

合同描述

false

-

procInstId

string

流程实例ID

false

-

procInstStatus

object

流程审批状态

false

-

submitTime

string

提交时间

false

-

approvedTime

string

审批时间

false

-

Request-example:

curl -X GET -H 'Authorization' -i /api/sale/contract/list?current=237&size=10&keyword=5s8f0b&column=4pccgz&asc=true&id=899&remark=ubikve&createUserId=100&loginUserId=611&createTimeStart=2023-09-27 17:34:57&createTimeEnd=2023-09-27 17:34:57&modifyUserId=344&modifyTimeStart=2023-09-27 17:34:57&modifyTimeEnd=2023-09-27 17:34:57&dataPermissionFlag=true&tempId=390&tagId=533&contractName=gil.paucek&contractNo=6lcyna&amt=9&contractStatus=ywowfi&contractDesc=zhmisu&procInstId=196&submitTime=2023-09-27 17:34:57&approvedTime=2023-09-27 17:34:57&orders[0].column=lyd8of&orders[0].asc=true

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "tt6lls",
      "defaultMsg": "nv237u",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "a1goar",
      "defaultMsg": "psqjds",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "w59yt8",
      "defaultMsg": "axoqep",
      "context": {
        "object": "any object"
      }
    }
  ]
}

10.6.删除

Type: DELETE

Author: duwh

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

Description: 删除

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

keys

array

主键id,[array of int64]

false

-

Request-example:

curl -X DELETE -H 'Authorization' -i /api/sale/contract/deleteSoft?keys=tcf4i8&keys=tcf4i8

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "1l9fx3",
      "defaultMsg": "yh8fkx",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "wfg2j5",
      "defaultMsg": "455a3m",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "e3ft9r",
      "defaultMsg": "9g3c1t",
      "context": {
        "object": "any object"
      }
    }
  ]
}

11.合同类别控制器

11.1.新增

Type: POST

Author: duwh

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

Description: 新增

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

id

int64

No comments found.

false

-

remark

string

No comments found.

false

-

createUserId

int64

No comments found.

false

-

creator

string

记录创建者

false

-

createTime

string

No comments found.

false

-

modifyUserId

int64

No comments found.

false

-

modifyTime

string

No comments found.

false

-

deleteFlag

int32

No comments found.

false

-

ignoreWarning

boolean

No comments found.

false

-

nullFields

array

No comments found.

false

-

changeLogId

int64

No comments found.

false

-

name

string

名称

false

-

categoryNo

string

类别编号

false

-

icon

string

图标

false

-

hiddenFlag

int32

隐藏标志 0：不隐藏，1：隐藏

false

-

sortNo

int32

排序

false

-

Request-example:

curl -X POST -H 'Authorization' -i /api/sale/contractCategory --data 'id=46&remark=b59li1&createUserId=505&creator=n1wj78&createTime=2023-09-27 17:34:57&modifyUserId=754&modifyTime=2023-09-27 17:34:57&deleteFlag=0&ignoreWarning=true&nullFields=m6cmlx,m6cmlx&changeLogId=839&name=gil.paucek&categoryNo=ub3kmk&icon=5udxid&hiddenFlag=0&sortNo=838'

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "jm9fke",
      "defaultMsg": "1vp9w0",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "yprbay",
      "defaultMsg": "vm78ke",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "3c4nbk",
      "defaultMsg": "iutgeh",
      "context": {
        "object": "any object"
      }
    }
  ]
}

11.2.更新

Type: PUT

Author: duwh

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

Description: 更新

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

id

int64

No comments found.

false

-

remark

string

No comments found.

false

-

createUserId

int64

No comments found.

false

-

creator

string

记录创建者

false

-

createTime

string

No comments found.

false

-

modifyUserId

int64

No comments found.

false

-

modifyTime

string

No comments found.

false

-

deleteFlag

int32

No comments found.

false

-

ignoreWarning

boolean

No comments found.

false

-

nullFields

array

No comments found.

false

-

changeLogId

int64

No comments found.

false

-

name

string

名称

false

-

categoryNo

string

类别编号

false

-

icon

string

图标

false

-

hiddenFlag

int32

隐藏标志 0：不隐藏，1：隐藏

false

-

sortNo

int32

排序

false

-

Request-example:

curl -X PUT -H 'Authorization' -i /api/sale/contractCategory --data 'id=553&remark=znhfuf&createUserId=921&creator=zn4qb0&createTime=2023-09-27 17:34:57&modifyUserId=373&modifyTime=2023-09-27 17:34:57&deleteFlag=0&ignoreWarning=true&nullFields=raxtso,raxtso&changeLogId=13&name=gil.paucek&categoryNo=tnbhmk&icon=rjh8jx&hiddenFlag=0&sortNo=885'

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "axh6qy",
      "defaultMsg": "pypmr4",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "pb7ja6",
      "defaultMsg": "ia1gd2",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "tan4j3",
      "defaultMsg": "b88bil",
      "context": {
        "object": "any object"
      }
    }
  ]
}

11.3.主键查询

Type: GET

Author: duwh

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

Description: 主键查询

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Path-parameters:

ParameterTypeDescriptionRequiredSince

key

int64

关键

true

-

Request-example:

curl -X GET -H 'Authorization' -i /api/sale/contractCategory/469

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "6ks84o",
      "defaultMsg": "n4cxw1",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "rjdz6j",
      "defaultMsg": "wucq5g",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "6pwzmo",
      "defaultMsg": "qw97m6",
      "context": {
        "object": "any object"
      }
    }
  ]
}

11.4.分页

Type: GET

Author: duwh

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

Description: 分页

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

current

int32

页码，默认为1

false

-

size

int32

页大小，默认为10

false

-

keyword

string

搜索关键字

false

-

idSet

object

ID

false

-

orders

array

排序

false

-

└─column

string

属性名称

false

-

└─asc

boolean

是否升序

false

-

id

int64

No comments found.

false

-

remark

string

No comments found.

false

-

createUserId

int64

No comments found.

false

-

loginUserId

int64

登录用户id 用于数据权限

false

-

createTimeStart

string

No comments found.

false

-

createTimeEnd

string

No comments found.

false

-

modifyUserId

int64

No comments found.

false

-

modifyTimeStart

string

No comments found.

false

-

modifyTimeEnd

string

No comments found.

false

-

dataPermissionFlag

boolean

No comments found.

false

-

name

string

名称

false

-

categoryNo

string

类别编号

false

-

icon

string

图标

false

-

hiddenFlag

int32

隐藏标志 0：不隐藏，1：隐藏

false

-

sortNo

int32

排序

false

-

Request-example:

curl -X GET -H 'Authorization' -i /api/sale/contractCategory/paging?current=216&size=10&keyword=osi0ew&column=e0l8o9&asc=true&id=133&remark=km6grm&createUserId=546&loginUserId=604&createTimeStart=2023-09-27 17:34:57&createTimeEnd=2023-09-27 17:34:57&modifyUserId=992&modifyTimeStart=2023-09-27 17:34:57&modifyTimeEnd=2023-09-27 17:34:57&dataPermissionFlag=true&name=gil.paucek&categoryNo=dhbv3c&icon=ar5ddy&hiddenFlag=0&sortNo=579&orders[0].column=ng18en&orders[0].asc=true

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "9h3d34",
      "defaultMsg": "setnsy",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "wwv3x8",
      "defaultMsg": "v3u210",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "gbgh72",
      "defaultMsg": "iwc78c",
      "context": {
        "object": "any object"
      }
    }
  ]
}

11.5.查询列表

Type: GET

Author: duwh

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

Description: 查询列表

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

current

int32

页码，默认为1

false

-

size

int32

页大小，默认为10

false

-

keyword

string

搜索关键字

false

-

idSet

object

ID

false

-

orders

array

排序

false

-

└─column

string

属性名称

false

-

└─asc

boolean

是否升序

false

-

id

int64

No comments found.

false

-

remark

string

No comments found.

false

-

createUserId

int64

No comments found.

false

-

loginUserId

int64

登录用户id 用于数据权限

false

-

createTimeStart

string

No comments found.

false

-

createTimeEnd

string

No comments found.

false

-

modifyUserId

int64

No comments found.

false

-

modifyTimeStart

string

No comments found.

false

-

modifyTimeEnd

string

No comments found.

false

-

dataPermissionFlag

boolean

No comments found.

false

-

name

string

名称

false

-

categoryNo

string

类别编号

false

-

icon

string

图标

false

-

hiddenFlag

int32

隐藏标志 0：不隐藏，1：隐藏

false

-

sortNo

int32

排序

false

-

Request-example:

curl -X GET -H 'Authorization' -i /api/sale/contractCategory/list?current=936&size=10&keyword=kdo886&column=vjjls9&asc=true&id=718&remark=umpw9f&createUserId=308&loginUserId=176&createTimeStart=2023-09-27 17:34:57&createTimeEnd=2023-09-27 17:34:57&modifyUserId=335&modifyTimeStart=2023-09-27 17:34:57&modifyTimeEnd=2023-09-27 17:34:57&dataPermissionFlag=true&name=gil.paucek&categoryNo=59bm0q&icon=uy29x0&hiddenFlag=0&sortNo=519&orders[0].column=c8quy6&orders[0].asc=true

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "002961",
      "defaultMsg": "p8h32l",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "kc8rjn",
      "defaultMsg": "hrts89",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "tf02hb",
      "defaultMsg": "r4zvro",
      "context": {
        "object": "any object"
      }
    }
  ]
}

11.6.删除

Type: DELETE

Author: duwh

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

Description: 删除

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

keys

array

主键id,[array of int64]

false

-

Request-example:

curl -X DELETE -H 'Authorization' -i /api/sale/contractCategory/deleteSoft?keys=8gj2uw&keys=8gj2uw

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "zez95g",
      "defaultMsg": "uozo45",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "stzmy4",
      "defaultMsg": "cfydnu",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "jafn77",
      "defaultMsg": "v6q9lu",
      "context": {
        "object": "any object"
      }
    }
  ]
}

12.日程管理

12.1.新建或修改

Type: POST

Author: zoey

Content-Type: application/json

Description: 新建或修改

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Body-parameters:

ParameterTypeDescriptionRequiredSince

id

int64

No comments found.

false

-

remark

string

No comments found.

false

-

createUserId

int64

No comments found.

false

-

creator

string

记录创建者

false

-

createTime

string

No comments found.

false

-

modifyUserId

int64

No comments found.

false

-

modifyTime

string

No comments found.

false

-

deleteFlag

int32

No comments found.

false

-

ignoreWarning

boolean

No comments found.

false

-

nullFields

array

No comments found.

false

-

changeLogId

int64

No comments found.

false

-

title

string

No comments found.

false

-

description

string

No comments found.

false

-

location

string

No comments found.

false

-

allDay

int32

No comments found.

false

-

startTime

string

No comments found.

false

-

endTime

string

No comments found.

false

-

calId

int64

No comments found.

false

-

allowActiveJoin

int32

No comments found.

false

-

isRepeat

int32

No comments found.

false

-

isRemind

int32

No comments found.

false

-

remindBeforeEventSecs

int32

No comments found.

false

-

attendees

array

No comments found.

false

-

└─id

int64

No comments found.

false

-

└─remark

string

No comments found.

false

-

└─createUserId

int64

No comments found.

false

-

└─creator

string

记录创建者

false

-

└─createTime

string

No comments found.

false

-

└─modifyUserId

int64

No comments found.

false

-

└─modifyTime

string

No comments found.

false

-

└─deleteFlag

int32

No comments found.

false

-

└─ignoreWarning

boolean

No comments found.

false

-

└─nullFields

array

No comments found.

false

-

└─changeLogId

int64

No comments found.

false

-

└─userId

int64

No comments found.

false

-

└─secheduleId

int64

No comments found.

false

-

repeat

object

No comments found.

false

-

└─id

int64

No comments found.

false

-

└─remark

string

No comments found.

false

-

└─createUserId

int64

No comments found.

false

-

└─creator

string

记录创建者

false

-

└─createTime

string

No comments found.

false

-

└─modifyUserId

int64

No comments found.

false

-

└─modifyTime

string

No comments found.

false

-

└─deleteFlag

int32

No comments found.

false

-

└─ignoreWarning

boolean

No comments found.

false

-

└─nullFields

array

No comments found.

false

-

└─changeLogId

int64

No comments found.

false

-

└─repeatType

int32

No comments found.

false

-

└─repeatUntil

string

No comments found.

false

-

└─isCustomRepeat

int32

No comments found.

false

-

└─repeatInterval

int32

No comments found.

false

-

└─repeatDayOfWeek

string

No comments found.

false

-

└─repeatDayOfMonth

string

No comments found.

false

-

└─exdate

string

No comments found.

false

-

└─secheduleId

int64

No comments found.

false

-

qyWxScheduleId

string

No comments found.

false

-

fromQyWx

boolean

No comments found.

false

-

skipAttendees

boolean

No comments found.

false

-

skipRepeat

boolean

No comments found.

false

-

Request-example:

curl -X POST -H 'Content-Type: application/json' -H 'Authorization' -i /api/scd/schedule/saveOne --data '{
  "id": 902,
  "remark": "g1eh1u",
  "createUserId": 392,
  "creator": "rj9ryg",
  "createTime": "2023-09-27 17:34:57",
  "modifyUserId": 140,
  "modifyTime": "2023-09-27 17:34:57",
  "deleteFlag": 0,
  "ignoreWarning": true,
  "nullFields": [
    "ysrzo0"
  ],
  "changeLogId": 259,
  "title": "ogobvg",
  "description": "kja3gk",
  "location": "6cslyn",
  "allDay": 784,
  "startTime": "2023-09-27 17:34:57",
  "endTime": "2023-09-27 17:34:57",
  "calId": 241,
  "allowActiveJoin": 927,
  "isRepeat": 19,
  "isRemind": 226,
  "remindBeforeEventSecs": 564,
  "attendees": [
    {
      "id": 471,
      "remark": "h5t524",
      "createUserId": 344,
      "creator": "ilwim9",
      "createTime": "2023-09-27 17:34:57",
      "modifyUserId": 692,
      "modifyTime": "2023-09-27 17:34:57",
      "deleteFlag": 0,
      "ignoreWarning": true,
      "nullFields": [
        "a5anul"
      ],
      "changeLogId": 712,
      "userId": 463,
      "secheduleId": 429
    }
  ],
  "repeat": {
    "id": 496,
    "remark": "3ft82n",
    "createUserId": 466,
    "creator": "6p0svd",
    "createTime": "2023-09-27 17:34:57",
    "modifyUserId": 18,
    "modifyTime": "2023-09-27 17:34:57",
    "deleteFlag": 0,
    "ignoreWarning": true,
    "nullFields": [
      "z23mwa"
    ],
    "changeLogId": 46,
    "repeatType": 695,
    "repeatUntil": "2023-09-27",
    "isCustomRepeat": 773,
    "repeatInterval": 950,
    "repeatDayOfWeek": "gjynrp",
    "repeatDayOfMonth": "krko12",
    "exdate": "2023-09-27",
    "secheduleId": 921
  },
  "qyWxScheduleId": "196",
  "fromQyWx": true,
  "skipAttendees": true,
  "skipRepeat": true
}'

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "olwyxe",
      "defaultMsg": "tlcclu",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "80j825",
      "defaultMsg": "38a0b3",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "vv5bvx",
      "defaultMsg": "foph4b",
      "context": {
        "object": "any object"
      }
    }
  ]
}

12.2.列表查询

Type: GET

Author: zoey

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

Description: 列表查询

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

current

int32

页码，默认为1

false

-

size

int32

页大小，默认为10

false

-

keyword

string

搜索关键字

false

-

idSet

object

ID

false

-

orders

array

排序

false

-

└─column

string

属性名称

false

-

└─asc

boolean

是否升序

false

-

id

int64

No comments found.

false

-

remark

string

No comments found.

false

-

createUserId

int64

No comments found.

false

-

loginUserId

int64

登录用户id 用于数据权限

false

-

createTimeStart

string

No comments found.

false

-

createTimeEnd

string

No comments found.

false

-

modifyUserId

int64

No comments found.

false

-

modifyTimeStart

string

No comments found.

false

-

modifyTimeEnd

string

No comments found.

false

-

dataPermissionFlag

boolean

No comments found.

false

-

title

string

No comments found.

false

-

description

string

No comments found.

false

-

location

string

No comments found.

false

-

allDay

int32

No comments found.

false

-

startTime

string

No comments found.

false

-

endTime

string

No comments found.

false

-

calId

int64

No comments found.

false

-

calIds

string

No comments found.

false

-

allowActiveJoin

int32

No comments found.

false

-

isRepeat

int32

No comments found.

false

-

isRemind

int32

No comments found.

false

-

remindBeforeEventSecs

int32

No comments found.

false

-

Request-example:

curl -X GET -H 'Authorization' -i /api/scd/schedule/list?current=967&size=10&keyword=weac3p&column=w3hn94&asc=true&id=533&remark=obielj&createUserId=782&loginUserId=360&createTimeStart=2023-09-27 17:34:57&createTimeEnd=2023-09-27 17:34:57&modifyUserId=997&modifyTimeStart=2023-09-27 17:34:57&modifyTimeEnd=2023-09-27 17:34:57&dataPermissionFlag=true&title=grziag&description=q4blwe&location=6y1fsl&allDay=96&startTime=2023-09-27 17:34:57&endTime=2023-09-27 17:34:57&calId=977&calIds=89&allowActiveJoin=514&isRepeat=632&isRemind=764&remindBeforeEventSecs=771&orders[0].column=ao4dii&orders[0].asc=true

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "erobn7",
      "defaultMsg": "iy766b",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "3l9eis",
      "defaultMsg": "6tf7g9",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "y7wbom",
      "defaultMsg": "qq5tnb",
      "context": {
        "object": "any object"
      }
    }
  ]
}

12.3.详情查询

Type: GET

Author: zoey

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

Description: 详情查询

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Path-parameters:

ParameterTypeDescriptionRequiredSince

id

int64

主键

true

-

Request-example:

curl -X GET -H 'Authorization' -i /api/scd/schedule/detail/547

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "as8jyw",
      "defaultMsg": "pj24rl",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "hkm6ym",
      "defaultMsg": "2vk3s1",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "6e3dsq",
      "defaultMsg": "bbikr0",
      "context": {
        "object": "any object"
      }
    }
  ]
}

12.4.逻辑删除

Type: DELETE

Author: zoey

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

Description: 逻辑删除

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

keys

array

主键,[array of int64]

false

-

Request-example:

curl -X DELETE -H 'Authorization' -i /api/scd/schedule/delete?keys=5w9bm1&keys=5w9bm1

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "632n2z",
      "defaultMsg": "jsrmjh",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "i8gfec",
      "defaultMsg": "mxlprc",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "p3ange",
      "defaultMsg": "nuto29",
      "context": {
        "object": "any object"
      }
    }
  ]
}

12.5.删除重复日程的当天日程（exdate排除）

Type: GET

Author: zoey

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

Description: 删除重复日程的当天日程（exdate排除）

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

scheduleId

int64

日程id

true

-

date

string

触发日期

true

-

Request-example:

curl -X GET -H 'Authorization' -i /api/scd/schedule/deleteCurrent?scheduleId=839&date=2023-09-27 --data '&839&2023-09-27'

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "20rmxv",
      "defaultMsg": "wm8gyx",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "k1heg4",
      "defaultMsg": "apqxds",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "kkluj4",
      "defaultMsg": "3knbfc",
      "context": {
        "object": "any object"
      }
    }
  ]
}

12.6.删除重复日程的当天及以后日程（更改重复规则）

Type: GET

Author: zoey

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

Description: 删除重复日程的当天及以后日程（更改重复规则）

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

scheduleId

int64

日程id

true

-

date

string

触发日期

true

-

Request-example:

curl -X GET -H 'Authorization' -i /api/scd/schedule/deleteAfter?scheduleId=693&date=2023-09-27 --data '&693&2023-09-27'

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "6khfed",
      "defaultMsg": "tvjs69",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "31ldaw",
      "defaultMsg": "gioryy",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "uyu3t2",
      "defaultMsg": "1kw4p4",
      "context": {
        "object": "any object"
      }
    }
  ]
}

12.7.更新重复日程的当天日程（exdate排除）

Type: POST

Author: zoey

Content-Type: application/json

Description: 更新重复日程的当天日程（exdate排除）

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Body-parameters:

ParameterTypeDescriptionRequiredSince

id

int64

No comments found.

false

-

remark

string

No comments found.

false

-

createUserId

int64

No comments found.

false

-

creator

string

记录创建者

false

-

createTime

string

No comments found.

false

-

modifyUserId

int64

No comments found.

false

-

modifyTime

string

No comments found.

false

-

deleteFlag

int32

No comments found.

false

-

ignoreWarning

boolean

No comments found.

false

-

nullFields

array

No comments found.

false

-

changeLogId

int64

No comments found.

false

-

title

string

No comments found.

false

-

description

string

No comments found.

false

-

location

string

No comments found.

false

-

allDay

int32

No comments found.

false

-

startTime

string

No comments found.

false

-

endTime

string

No comments found.

false

-

calId

int64

No comments found.

false

-

allowActiveJoin

int32

No comments found.

false

-

isRepeat

int32

No comments found.

false

-

isRemind

int32

No comments found.

false

-

remindBeforeEventSecs

int32

No comments found.

false

-

attendees

array

No comments found.

false

-

└─id

int64

No comments found.

false

-

└─remark

string

No comments found.

false

-

└─createUserId

int64

No comments found.

false

-

└─creator

string

记录创建者

false

-

└─createTime

string

No comments found.

false

-

└─modifyUserId

int64

No comments found.

false

-

└─modifyTime

string

No comments found.

false

-

└─deleteFlag

int32

No comments found.

false

-

└─ignoreWarning

boolean

No comments found.

false

-

└─nullFields

array

No comments found.

false

-

└─changeLogId

int64

No comments found.

false

-

└─userId

int64

No comments found.

false

-

└─secheduleId

int64

No comments found.

false

-

repeat

object

No comments found.

false

-

└─id

int64

No comments found.

false

-

└─remark

string

No comments found.

false

-

└─createUserId

int64

No comments found.

false

-

└─creator

string

记录创建者

false

-

└─createTime

string

No comments found.

false

-

└─modifyUserId

int64

No comments found.

false

-

└─modifyTime

string

No comments found.

false

-

└─deleteFlag

int32

No comments found.

false

-

└─ignoreWarning

boolean

No comments found.

false

-

└─nullFields

array

No comments found.

false

-

└─changeLogId

int64

No comments found.

false

-

└─repeatType

int32

No comments found.

false

-

└─repeatUntil

string

No comments found.

false

-

└─isCustomRepeat

int32

No comments found.

false

-

└─repeatInterval

int32

No comments found.

false

-

└─repeatDayOfWeek

string

No comments found.

false

-

└─repeatDayOfMonth

string

No comments found.

false

-

└─exdate

string

No comments found.

false

-

└─secheduleId

int64

No comments found.

false

-

qyWxScheduleId

string

No comments found.

false

-

fromQyWx

boolean

No comments found.

false

-

skipAttendees

boolean

No comments found.

false

-

skipRepeat

boolean

No comments found.

false

-

Request-example:

curl -X POST -H 'Content-Type: application/json' -H 'Authorization' -i /api/scd/schedule/updateCurrent --data '{
  "id": 969,
  "remark": "i5q6h9",
  "createUserId": 930,
  "creator": "yf8o3c",
  "createTime": "2023-09-27 17:34:57",
  "modifyUserId": 630,
  "modifyTime": "2023-09-27 17:34:57",
  "deleteFlag": 0,
  "ignoreWarning": true,
  "nullFields": [
    "vzk116"
  ],
  "changeLogId": 519,
  "title": "3q8ngv",
  "description": "v550pk",
  "location": "cvn38v",
  "allDay": 846,
  "startTime": "2023-09-27 17:34:57",
  "endTime": "2023-09-27 17:34:57",
  "calId": 188,
  "allowActiveJoin": 542,
  "isRepeat": 784,
  "isRemind": 467,
  "remindBeforeEventSecs": 942,
  "attendees": [
    {
      "id": 23,
      "remark": "x1g358",
      "createUserId": 511,
      "creator": "wj4hqt",
      "createTime": "2023-09-27 17:34:57",
      "modifyUserId": 931,
      "modifyTime": "2023-09-27 17:34:57",
      "deleteFlag": 0,
      "ignoreWarning": true,
      "nullFields": [
        "gfp86b"
      ],
      "changeLogId": 425,
      "userId": 361,
      "secheduleId": 464
    }
  ],
  "repeat": {
    "id": 919,
    "remark": "vrwp9e",
    "createUserId": 600,
    "creator": "y99z4f",
    "createTime": "2023-09-27 17:34:57",
    "modifyUserId": 316,
    "modifyTime": "2023-09-27 17:34:57",
    "deleteFlag": 0,
    "ignoreWarning": true,
    "nullFields": [
      "gi7kbv"
    ],
    "changeLogId": 781,
    "repeatType": 42,
    "repeatUntil": "2023-09-27",
    "isCustomRepeat": 425,
    "repeatInterval": 913,
    "repeatDayOfWeek": "daiqsp",
    "repeatDayOfMonth": "fgscvc",
    "exdate": "2023-09-27",
    "secheduleId": 188
  },
  "qyWxScheduleId": "196",
  "fromQyWx": true,
  "skipAttendees": true,
  "skipRepeat": true
}'

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "wfbyqk",
      "defaultMsg": "7w6zdq",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "u1g44m",
      "defaultMsg": "u5p3um",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "r6zddh",
      "defaultMsg": "0s1e7q",
      "context": {
        "object": "any object"
      }
    }
  ]
}

12.8.更新重复日程的当天及以后日程（更改重复规则）

Type: POST

Author: zoey

Content-Type: application/json

Description: 更新重复日程的当天及以后日程（更改重复规则）

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Body-parameters:

ParameterTypeDescriptionRequiredSince

id

int64

No comments found.

false

-

remark

string

No comments found.

false

-

createUserId

int64

No comments found.

false

-

creator

string

记录创建者

false

-

createTime

string

No comments found.

false

-

modifyUserId

int64

No comments found.

false

-

modifyTime

string

No comments found.

false

-

deleteFlag

int32

No comments found.

false

-

ignoreWarning

boolean

No comments found.

false

-

nullFields

array

No comments found.

false

-

changeLogId

int64

No comments found.

false

-

title

string

No comments found.

false

-

description

string

No comments found.

false

-

location

string

No comments found.

false

-

allDay

int32

No comments found.

false

-

startTime

string

No comments found.

false

-

endTime

string

No comments found.

false

-

calId

int64

No comments found.

false

-

allowActiveJoin

int32

No comments found.

false

-

isRepeat

int32

No comments found.

false

-

isRemind

int32

No comments found.

false

-

remindBeforeEventSecs

int32

No comments found.

false

-

attendees

array

No comments found.

false

-

└─id

int64

No comments found.

false

-

└─remark

string

No comments found.

false

-

└─createUserId

int64

No comments found.

false

-

└─creator

string

记录创建者

false

-

└─createTime

string

No comments found.

false

-

└─modifyUserId

int64

No comments found.

false

-

└─modifyTime

string

No comments found.

false

-

└─deleteFlag

int32

No comments found.

false

-

└─ignoreWarning

boolean

No comments found.

false

-

└─nullFields

array

No comments found.

false

-

└─changeLogId

int64

No comments found.

false

-

└─userId

int64

No comments found.

false

-

└─secheduleId

int64

No comments found.

false

-

repeat

object

No comments found.

false

-

└─id

int64

No comments found.

false

-

└─remark

string

No comments found.

false

-

└─createUserId

int64

No comments found.

false

-

└─creator

string

记录创建者

false

-

└─createTime

string

No comments found.

false

-

└─modifyUserId

int64

No comments found.

false

-

└─modifyTime

string

No comments found.

false

-

└─deleteFlag

int32

No comments found.

false

-

└─ignoreWarning

boolean

No comments found.

false

-

└─nullFields

array

No comments found.

false

-

└─changeLogId

int64

No comments found.

false

-

└─repeatType

int32

No comments found.

false

-

└─repeatUntil

string

No comments found.

false

-

└─isCustomRepeat

int32

No comments found.

false

-

└─repeatInterval

int32

No comments found.

false

-

└─repeatDayOfWeek

string

No comments found.

false

-

└─repeatDayOfMonth

string

No comments found.

false

-

└─exdate

string

No comments found.

false

-

└─secheduleId

int64

No comments found.

false

-

qyWxScheduleId

string

No comments found.

false

-

fromQyWx

boolean

No comments found.

false

-

skipAttendees

boolean

No comments found.

false

-

skipRepeat

boolean

No comments found.

false

-

Request-example:

curl -X POST -H 'Content-Type: application/json' -H 'Authorization' -i /api/scd/schedule/updateAfter --data '{
  "id": 821,
  "remark": "7iffml",
  "createUserId": 442,
  "creator": "fzx2kj",
  "createTime": "2023-09-27 17:34:57",
  "modifyUserId": 560,
  "modifyTime": "2023-09-27 17:34:57",
  "deleteFlag": 0,
  "ignoreWarning": true,
  "nullFields": [
    "mtddwj"
  ],
  "changeLogId": 773,
  "title": "0t72er",
  "description": "0wmw0p",
  "location": "miuux1",
  "allDay": 805,
  "startTime": "2023-09-27 17:34:57",
  "endTime": "2023-09-27 17:34:57",
  "calId": 522,
  "allowActiveJoin": 428,
  "isRepeat": 206,
  "isRemind": 528,
  "remindBeforeEventSecs": 76,
  "attendees": [
    {
      "id": 506,
      "remark": "bwaubk",
      "createUserId": 335,
      "creator": "q7wbva",
      "createTime": "2023-09-27 17:34:57",
      "modifyUserId": 729,
      "modifyTime": "2023-09-27 17:34:57",
      "deleteFlag": 0,
      "ignoreWarning": true,
      "nullFields": [
        "phhnvf"
      ],
      "changeLogId": 36,
      "userId": 361,
      "secheduleId": 644
    }
  ],
  "repeat": {
    "id": 517,
    "remark": "haeow1",
    "createUserId": 16,
    "creator": "piclyh",
    "createTime": "2023-09-27 17:34:57",
    "modifyUserId": 610,
    "modifyTime": "2023-09-27 17:34:57",
    "deleteFlag": 0,
    "ignoreWarning": true,
    "nullFields": [
      "x6cmrs"
    ],
    "changeLogId": 874,
    "repeatType": 970,
    "repeatUntil": "2023-09-27",
    "isCustomRepeat": 735,
    "repeatInterval": 788,
    "repeatDayOfWeek": "bdwb3b",
    "repeatDayOfMonth": "3k1rto",
    "exdate": "2023-09-27",
    "secheduleId": 348
  },
  "qyWxScheduleId": "196",
  "fromQyWx": true,
  "skipAttendees": true,
  "skipRepeat": true
}'

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "eviocm",
      "defaultMsg": "sqvf91",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "02f395",
      "defaultMsg": "gx3l0m",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "544gcd",
      "defaultMsg": "de8uug",
      "context": {
        "object": "any object"
      }
    }
  ]
}

13.日历管理

13.1.新建或修改

Type: POST

Author: zoey

Content-Type: application/json

Description: 新建或修改

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Body-parameters:

ParameterTypeDescriptionRequiredSince

id

int64

No comments found.

false

-

remark

string

No comments found.

false

-

createUserId

int64

No comments found.

false

-

creator

string

记录创建者

false

-

createTime

string

No comments found.

false

-

modifyUserId

int64

No comments found.

false

-

modifyTime

string

No comments found.

false

-

deleteFlag

int32

No comments found.

false

-

ignoreWarning

boolean

No comments found.

false

-

nullFields

array

No comments found.

false

-

changeLogId

int64

No comments found.

false

-

readonly

int32

No comments found.

false

-

defaultFlag

int32

No comments found.

false

-

title

string

No comments found.

false

-

description

string

No comments found.

false

-

color

string

No comments found.

false

-

shares

array

No comments found.

false

-

└─id

int64

No comments found.

false

-

└─remark

string

No comments found.

false

-

└─createUserId

int64

No comments found.

false

-

└─creator

string

记录创建者

false

-

└─createTime

string

No comments found.

false

-

└─modifyUserId

int64

No comments found.

false

-

└─modifyTime

string

No comments found.

false

-

└─deleteFlag

int32

No comments found.

false

-

└─ignoreWarning

boolean

No comments found.

false

-

└─nullFields

array

No comments found.

false

-

└─changeLogId

int64

No comments found.

false

-

└─readonly

int32

No comments found.

false

-

└─calId

int64

No comments found.

false

-

└─userId

int64

No comments found.

false

-

qyWxCalId

string

No comments found.

false

-

fromQyWx

boolean

No comments found.

false

-

skipShares

boolean

No comments found.

false

-

Request-example:

curl -X POST -H 'Content-Type: application/json' -H 'Authorization' -i /api/scd/calendar/saveOne --data '{
  "id": 2,
  "remark": "zutw4d",
  "createUserId": 43,
  "creator": "oh6bpd",
  "createTime": "2023-09-27 17:34:57",
  "modifyUserId": 528,
  "modifyTime": "2023-09-27 17:34:57",
  "deleteFlag": 0,
  "ignoreWarning": true,
  "nullFields": [
    "frn7rs"
  ],
  "changeLogId": 982,
  "readonly": 279,
  "defaultFlag": 0,
  "title": "ptliqa",
  "description": "8cpsqg",
  "color": "adl6b8",
  "shares": [
    {
      "id": 918,
      "remark": "8tgcyw",
      "createUserId": 595,
      "creator": "4ck6d6",
      "createTime": "2023-09-27 17:34:57",
      "modifyUserId": 930,
      "modifyTime": "2023-09-27 17:34:57",
      "deleteFlag": 0,
      "ignoreWarning": true,
      "nullFields": [
        "9v5p8z"
      ],
      "changeLogId": 952,
      "readonly": 510,
      "calId": 426,
      "userId": 107
    }
  ],
  "qyWxCalId": "196",
  "fromQyWx": true,
  "skipShares": true
}'

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "l59vw7",
      "defaultMsg": "2lae3h",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "jk1nit",
      "defaultMsg": "1x26lk",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "eckugf",
      "defaultMsg": "xd5ps2",
      "context": {
        "object": "any object"
      }
    }
  ]
}

13.2.列表查询不分页(默认列表)

Type: GET

Author: zoey

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

Description: 列表查询不分页(默认列表)

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

current

int32

页码，默认为1

false

-

size

int32

页大小，默认为10

false

-

keyword

string

搜索关键字

false

-

idSet

object

ID

false

-

orders

array

排序

false

-

└─column

string

属性名称

false

-

└─asc

boolean

是否升序

false

-

id

int64

No comments found.

false

-

remark

string

No comments found.

false

-

createUserId

int64

No comments found.

false

-

loginUserId

int64

登录用户id 用于数据权限

false

-

createTimeStart

string

No comments found.

false

-

createTimeEnd

string

No comments found.

false

-

modifyUserId

int64

No comments found.

false

-

modifyTimeStart

string

No comments found.

false

-

modifyTimeEnd

string

No comments found.

false

-

dataPermissionFlag

boolean

No comments found.

false

-

calIds

array

No comments found.

false

-

defaultFlag

int32

No comments found.

false

-

title

string

No comments found.

false

-

description

string

No comments found.

false

-

Request-example:

curl -X GET -H 'Authorization' -i /api/scd/calendar/list?current=810&size=10&keyword=zt0tbl&column=v0phxk&asc=true&id=758&remark=2rv65s&createUserId=228&loginUserId=275&createTimeStart=2023-09-27 17:34:57&createTimeEnd=2023-09-27 17:34:57&modifyUserId=53&modifyTimeStart=2023-09-27 17:34:57&modifyTimeEnd=2023-09-27 17:34:57&dataPermissionFlag=true&calIds=442,442&defaultFlag=0&title=xquu5t&description=yykh5k&orders[0].asc=true&orders[0].column=lvd37h

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "z90aem",
      "defaultMsg": "hj6o5l",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "zk5aso",
      "defaultMsg": "lnjnhq",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "qfsag1",
      "defaultMsg": "rxakue",
      "context": {
        "object": "any object"
      }
    }
  ]
}

13.3.详情查询

Type: GET

Author: zoey

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

Description: 详情查询

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Path-parameters:

ParameterTypeDescriptionRequiredSince

id

int64

主键

true

-

Request-example:

curl -X GET -H 'Authorization' -i /api/scd/calendar/detail/157

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "9nxmrv",
      "defaultMsg": "9pf2yk",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "ztsj41",
      "defaultMsg": "kcmhpi",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "avnjv4",
      "defaultMsg": "ymyagu",
      "context": {
        "object": "any object"
      }
    }
  ]
}

13.4.逻辑删除

Type: DELETE

Author: zoey

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

Description: 逻辑删除

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

keys

array

主键,[array of int64]

false

-

Request-example:

curl -X DELETE -H 'Authorization' -i /api/scd/calendar/delete?keys=1n730f&keys=1n730f

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "k9c1f0",
      "defaultMsg": "jztxtg",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "pfpzh8",
      "defaultMsg": "citxm3",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "6fx7kx",
      "defaultMsg": "qofrzy",
      "context": {
        "object": "any object"
      }
    }
  ]
}

14.APP-用户服务

14.1.APP-用户服务-查询个人数据
移动端获取个人信息

Type: GET

Author: duwh

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

Description: APP-用户服务-查询个人数据
移动端获取个人信息

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Request-example:

curl -X GET -H 'Authorization' -i /api/app/user/queryDetail

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "373vws",
      "defaultMsg": "njrkg8",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "t43qse",
      "defaultMsg": "l34xd0",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "ystxjf",
      "defaultMsg": "e9c9ag",
      "context": {
        "object": "any object"
      }
    }
  ]
}

14.2.APP-用户服务-修改

Type: PUT

Author: duwh

Content-Type: application/json

Description: APP-用户服务-修改

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Body-parameters:

ParameterTypeDescriptionRequiredSince

id

int64

No comments found.

false

-

remark

string

No comments found.

false

-

createUserId

int64

No comments found.

false

-

creator

string

记录创建者

false

-

createTime

string

No comments found.

false

-

modifyUserId

int64

No comments found.

false

-

modifyTime

string

No comments found.

false

-

deleteFlag

int32

No comments found.

false

-

ignoreWarning

boolean

No comments found.

false

-

nullFields

array

No comments found.

false

-

changeLogId

int64

No comments found.

false

-

userName

string

用户账号

false

-

lastName

string

用户姓氏

false

-

personName

string

用户真实姓名

false

-

mobile

string

用户电话

false

-

email

string

用户邮箱

false

-

enabled

boolean

账户状态

false

-

personId

int64

No comments found.

false

-

roleIds

array

角色IDs 如果修改的时候传值是 “null”表示赋值角色没有改变，如果是空数组“[]”表示把赋值角色全部删除

false

-

userId

int64

No comments found.

false

-

companyId

int64

公司ID

false

-

employeeNo

string

员工编号

false

-

employeeName

string

员工名称

false

-

resourceStatus

string

资源状态

false

-

hrStatus

string

人事状态

false

-

enrollDate

string

入职日期

false

-

accessLevel

int32

安全级别

false

-

jobs

string

岗位

false

-

sortIndex

int32

No comments found.

false

-

foreignName

string

外文名

false

-

idType

string

证件类型

false

-

idNo

string

证件号码

false

-

idValidFrom

string

证件开始日

false

-

idValidTo

string

证件到期日

false

-

idValidCodes

string

证件url

false

-

headCodes

string

头像url

false

-

birthday

string

生日

false

-

sex

string

性别

false

-

nationality

string

国籍

false

-

birthplace

string

籍贯

false

-

nation

string

民族

false

-

marital

int32

婚姻状况 0:已婚，1：未婚

false

-

addr

string

通讯地址

false

-

urgency_name

string

紧急联系人

false

-

urgency_mobile

string

紧急联系人手机号

false

-

urgency_ref

string

紧急联系人关系

false

-

parentNo

string

No comments found.

false

-

extString1

string

专业级别

false

-

extString2

string

管理级别

false

-

extString3

string

专业序列

false

-

extString4

string

职位序列

false

-

extString5

string

主服务地址

false

-

extString6

string

内部类型：内部资源，外部资源

false

-

extString7

string

话费额度

false

-

extString8

string

电脑额度

false

-

extString9

string

资源类型2 正式员工，实行生等

false

-

extString10

string

No comments found.

false

-

extString11

string

No comments found.

false

-

extString12

string

No comments found.

false

-

extDate1

string

离职日期

false

-

extDate2

string

转正日期

false

-

extDate3

string

合同签订日期

false

-

extDate4

string

合同到期日

false

-

extDate5

string

实习入职日期

false

-

extDate6

string

试用期开始

false

-

extDate7

string

试用期结束

false

-

extDate8

string

No comments found.

false

-

orgId

int64

组织id（新建员工初始默认组织使用）

false

-

parentId

int64

上级员工id（新建员工初始默认组织使用）

false

-

subType

string

修改类型

false

-

initTenantId

int64

通过租户初始化数据 租户id

false

-

Request-example:

curl -X PUT -H 'Content-Type: application/json' -H 'Authorization' -i /api/app/employee/update --data '{
  "id": 166,
  "remark": "9fyr5r",
  "createUserId": 112,
  "creator": "gkg9qh",
  "createTime": "2023-09-27 17:34:57",
  "modifyUserId": 233,
  "modifyTime": "2023-09-27 17:34:57",
  "deleteFlag": 0,
  "ignoreWarning": true,
  "nullFields": [
    "ls4rga"
  ],
  "changeLogId": 980,
  "userName": "gil.paucek",
  "lastName": "gil.paucek",
  "personName": "gil.paucek",
  "mobile": "269.440.6235",
  "email": "maple.huel@hotmail.com",
  "enabled": true,
  "personId": 610,
  "roleIds": [
    59
  ],
  "userId": 74,
  "companyId": 451,
  "employeeNo": "840o4h",
  "employeeName": "gil.paucek",
  "resourceStatus": "zlu911",
  "hrStatus": "7026km",
  "enrollDate": "2023-09-27",
  "accessLevel": 730,
  "jobs": "k35o90",
  "sortIndex": 1,
  "foreignName": "gil.paucek",
  "idType": "wlnlq4",
  "idNo": "kwf5er",
  "idValidFrom": "2023-09-27",
  "idValidTo": "2023-09-27",
  "idValidCodes": "on5qbl",
  "headCodes": "oe1ech",
  "birthday": "2023-09-27",
  "sex": "zqlzs2",
  "nationality": "04tgq4",
  "birthplace": "kkm4np",
  "nation": "mllwcf",
  "marital": 377,
  "addr": "tc9d73",
  "urgency_name": "gil.paucek",
  "urgency_mobile": "269.440.6235",
  "urgency_ref": "h0p2kf",
  "parentNo": "ykfu53",
  "extString1": "bzoeba",
  "extString2": "79t4u7",
  "extString3": "93k0qw",
  "extString4": "9aqdj4",
  "extString5": "5fiixt",
  "extString6": "bat03x",
  "extString7": "vac3sm",
  "extString8": "od0t13",
  "extString9": "kr69xl",
  "extString10": "awecki",
  "extString11": "y86b7y",
  "extString12": "e3vbup",
  "extDate1": "2023-09-27",
  "extDate2": "2023-09-27",
  "extDate3": "2023-09-27",
  "extDate4": "2023-09-27",
  "extDate5": "2023-09-27",
  "extDate6": "2023-09-27",
  "extDate7": "2023-09-27",
  "extDate8": "2023-09-27",
  "orgId": 223,
  "parentId": 255,
  "subType": "bjoi6z",
  "initTenantId": 979
}'

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "54i6px",
      "defaultMsg": "cgcsv1",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "32r3d4",
      "defaultMsg": "by3uh9",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "c64dxn",
      "defaultMsg": "bd2cjx",
      "context": {
        "object": "any object"
      }
    }
  ]
}

15.APP版本管理

15.1.新增

Type: POST

Author: duwh

Content-Type: application/json

Description: 新增

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Body-parameters:

ParameterTypeDescriptionRequiredSince

id

int64

No comments found.

false

-

remark

string

No comments found.

false

-

createUserId

int64

No comments found.

false

-

creator

string

记录创建者

false

-

createTime

string

No comments found.

false

-

modifyUserId

int64

No comments found.

false

-

modifyTime

string

No comments found.

false

-

deleteFlag

int32

No comments found.

false

-

ignoreWarning

boolean

No comments found.

false

-

nullFields

array

No comments found.

false

-

changeLogId

int64

No comments found.

false

-

name

string

版本名称

false

-

version

int32

版本号

false

-

content

string

更新日志

false

-

forceFlag

int32

强制更新标记，0：不强制更新，1：强制更新

false

-

fileCode

string

文件地址code(安卓安卓包)

false

-

downloadUrl

string

下载地址（安卓安装包）

false

-

type

string

ALL 所有；Android 安卓； IOS 苹果手机

false

-

showFlag

int32

是否展示 0 不展示 1展示

false

-

ext1

string

拓展1

false

-

ext2

string

拓展2

false

-

ext3

string

拓展3

false

-

ext4

string

拓展4

false

-

ext5

string

拓展5

false

-

Request-example:

curl -X POST -H 'Content-Type: application/json' -H 'Authorization' -i /api/app/appVersion --data '{
  "id": 273,
  "remark": "bk6ub7",
  "createUserId": 98,
  "creator": "cxawue",
  "createTime": "2023-09-27 17:34:57",
  "modifyUserId": 440,
  "modifyTime": "2023-09-27 17:34:57",
  "deleteFlag": 0,
  "ignoreWarning": true,
  "nullFields": [
    "yrx7cd"
  ],
  "changeLogId": 664,
  "name": "gil.paucek",
  "version": 434,
  "content": "ojvdp0",
  "forceFlag": 0,
  "fileCode": "88129",
  "downloadUrl": "www.lauretta-parisian.org",
  "type": "r3ybb6",
  "showFlag": 0,
  "ext1": "xuftoy",
  "ext2": "dor9hy",
  "ext3": "y3p34r",
  "ext4": "vsdi53",
  "ext5": "ku9emw"
}'

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "naw0s6",
      "defaultMsg": "7zym3v",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "ea5jqk",
      "defaultMsg": "253mi1",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "apu5zg",
      "defaultMsg": "ebade0",
      "context": {
        "object": "any object"
      }
    }
  ]
}

15.2.更新

Type: PUT

Author: duwh

Content-Type: application/json

Description: 更新

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Body-parameters:

ParameterTypeDescriptionRequiredSince

id

int64

No comments found.

false

-

remark

string

No comments found.

false

-

createUserId

int64

No comments found.

false

-

creator

string

记录创建者

false

-

createTime

string

No comments found.

false

-

modifyUserId

int64

No comments found.

false

-

modifyTime

string

No comments found.

false

-

deleteFlag

int32

No comments found.

false

-

ignoreWarning

boolean

No comments found.

false

-

nullFields

array

No comments found.

false

-

changeLogId

int64

No comments found.

false

-

name

string

版本名称

false

-

version

int32

版本号

false

-

content

string

更新日志

false

-

forceFlag

int32

强制更新标记，0：不强制更新，1：强制更新

false

-

fileCode

string

文件地址code(安卓安卓包)

false

-

downloadUrl

string

下载地址（安卓安装包）

false

-

type

string

ALL 所有；Android 安卓； IOS 苹果手机

false

-

showFlag

int32

是否展示 0 不展示 1展示

false

-

ext1

string

拓展1

false

-

ext2

string

拓展2

false

-

ext3

string

拓展3

false

-

ext4

string

拓展4

false

-

ext5

string

拓展5

false

-

Request-example:

curl -X PUT -H 'Content-Type: application/json' -H 'Authorization' -i /api/app/appVersion --data '{
  "id": 740,
  "remark": "io2oiv",
  "createUserId": 967,
  "creator": "hnmavg",
  "createTime": "2023-09-27 17:34:57",
  "modifyUserId": 658,
  "modifyTime": "2023-09-27 17:34:57",
  "deleteFlag": 0,
  "ignoreWarning": true,
  "nullFields": [
    "6b7lv1"
  ],
  "changeLogId": 565,
  "name": "gil.paucek",
  "version": 87,
  "content": "5tr0it",
  "forceFlag": 0,
  "fileCode": "88129",
  "downloadUrl": "www.lauretta-parisian.org",
  "type": "nhrrzo",
  "showFlag": 0,
  "ext1": "ziy7a4",
  "ext2": "0omh3a",
  "ext3": "uckn7c",
  "ext4": "0rzrtv",
  "ext5": "ajsnpl"
}'

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "gtngk8",
      "defaultMsg": "jizh3p",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "li7dnp",
      "defaultMsg": "9qsc8u",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "jb5h85",
      "defaultMsg": "mda5kl",
      "context": {
        "object": "any object"
      }
    }
  ]
}

15.3.主键查询

Type: GET

Author: duwh

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

Description: 主键查询

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Path-parameters:

ParameterTypeDescriptionRequiredSince

key

int64

关键

true

-

Request-example:

curl -X GET -H 'Authorization' -i /api/app/appVersion/900

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "s0fiot",
      "defaultMsg": "9t6bpc",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "hd0ejm",
      "defaultMsg": "t0yaf5",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "3t4xov",
      "defaultMsg": "qi7rra",
      "context": {
        "object": "any object"
      }
    }
  ]
}

15.4.分页

Type: GET

Author: duwh

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

Description: 分页

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

current

int32

页码，默认为1

false

-

size

int32

页大小，默认为10

false

-

keyword

string

搜索关键字

false

-

idSet

object

ID

false

-

orders

array

排序

false

-

└─column

string

属性名称

false

-

└─asc

boolean

是否升序

false

-

id

int64

No comments found.

false

-

remark

string

No comments found.

false

-

createUserId

int64

No comments found.

false

-

loginUserId

int64

登录用户id 用于数据权限

false

-

createTimeStart

string

No comments found.

false

-

createTimeEnd

string

No comments found.

false

-

modifyUserId

int64

No comments found.

false

-

modifyTimeStart

string

No comments found.

false

-

modifyTimeEnd

string

No comments found.

false

-

dataPermissionFlag

boolean

No comments found.

false

-

name

string

版本名称 模糊

false

-

version

int32

版本号 精确

false

-

content

string

更新日志 模糊

false

-

forceFlag

int32

强制更新标记，0：不强制更新，1：强制更新 精确

false

-

fileCode

string

文件地址code(安卓安卓包) 精确

false

-

downloadUrl

string

下载地址（安卓安装包） 模糊

false

-

showFlag

int32

是否展示 0 不展示 1展示

false

-

type

string

ALL 所有；Android 安卓； IOS 苹果手机 精确

false

-

ext1

string

拓展1 模糊

false

-

ext2

string

拓展2 模糊

false

-

ext3

string

拓展3 模糊

false

-

ext4

string

拓展4 模糊

false

-

ext5

string

拓展5 模糊

false

-

Request-example:

curl -X GET -H 'Authorization' -i /api/app/appVersion/paging?current=409&size=10&keyword=tun52l&column=gt8ycb&asc=true&id=235&remark=pvrwv1&createUserId=314&loginUserId=661&createTimeStart=2023-09-27 17:34:57&createTimeEnd=2023-09-27 17:34:57&modifyUserId=226&modifyTimeStart=2023-09-27 17:34:57&modifyTimeEnd=2023-09-27 17:34:57&dataPermissionFlag=true&name=gil.paucek&version=426&content=zplf08&forceFlag=0&fileCode=88129&downloadUrl=www.lauretta-parisian.org&showFlag=0&type=keoe26&ext1=718nbb&ext2=2ve6j2&ext3=lcbcjz&ext4=w51osx&ext5=jhghht&orders[0].column=7jiiz0&orders[0].asc=true

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "62ko1a",
      "defaultMsg": "glhcw1",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "ypgkj9",
      "defaultMsg": "k6kft9",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "dndmaq",
      "defaultMsg": "o3jnas",
      "context": {
        "object": "any object"
      }
    }
  ]
}

15.5.获得当前版本

Type: GET

Author: duwh

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

Description: 获得当前版本

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Request-example:

curl -X GET -H 'Authorization' -i /api/app/appVersion/getCurrentVersion

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "qni4iw",
      "defaultMsg": "pujtua",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "q33m9h",
      "defaultMsg": "8471rv",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "lyq4dm",
      "defaultMsg": "qln6ho",
      "context": {
        "object": "any object"
      }
    }
  ]
}

15.6.删除

Type: DELETE

Author: duwh

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

Description: 删除

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

keys

array

主键id,[array of int64]

false

-

Request-example:

curl -X DELETE -H 'Authorization' -i /api/app/appVersion/deleteSoft?keys=r1c4p1&keys=r1c4p1

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "b5ymz2",
      "defaultMsg": "rojgxm",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "pt7vrf",
      "defaultMsg": "yn3nzs",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "uebqg4",
      "defaultMsg": "gk2d4j",
      "context": {
        "object": "any object"
      }
    }
  ]
}

16.office在线编辑

16.1.获取在线编辑配置信息

Type: POST

Author: duwh

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

Description: 获取在线编辑配置信息

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

fileId

int64

文件标识

true

-

action

string

操作参数

false

-

actionLink

string

行动联系

false

-

userId

int64

用户id

false

-

Request-example:

curl -X POST -H 'Authorization' -i /api/office/react/edit --data 'fileId=773&action=si93s5&actionLink=qob9ll&userId=489'

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "derl5h",
      "defaultMsg": "4rb0pa",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "upsj27",
      "defaultMsg": "3ub7u9",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "5evcju",
      "defaultMsg": "z0l4v6",
      "context": {
        "object": "any object"
      }
    }
  ]
}

16.2.下载历史版本文件

Type: GET

Author: duwh

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

Description: 下载历史版本文件

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

fileId

string

文件标识

true

-

ver

string

版本

true

-

file

string

文件

true

-

Request-example:

curl -X GET -H 'Authorization' -i /api/office/downloadhistory?fileId=196&ver=0.39&file=6ir2fr --data '&196&0.39&6ir2fr'

Response-example:

File download.

16.3.

Type: GET

Author: duwh

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

Description: 

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

fileId

int64

No comments found.

true

-

action

string

No comments found.

false

-

actionLink

string

No comments found.

false

-

userId

int64

No comments found.

false

-

Request-example:

curl -X GET -H 'Authorization' -i /api/office/editPro?fileId=966&action=ohns9t&actionLink=nkz7ln&userId=32 --data '&966&ohns9t&nkz7ln'

Response-example:

string

16.4.编辑器回调

Type: GET

Author: duwh

Content-Type: application/json

Description: 编辑器回调

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

fileId

int64

文件标识

false

-

oldFileId

int64

旧文件id

false

-

Body-parameters:

ParameterTypeDescriptionRequiredSince

filetype

string

No comments found.

false

-

url

string

No comments found.

false

-

key

string

No comments found.

false

-

changesurl

string

No comments found.

false

-

history

object

No comments found.

false

-

└─serverVersion

string

No comments found.

false

-

└─key

string

No comments found.

false

-

└─version

int32

No comments found.

false

-

└─created

string

No comments found.

false

-

└─user

object

No comments found.

false

-

     └─id

string

No comments found.

false

-

     └─name

string

No comments found.

false

-

     └─group

string

No comments found.

false

-

└─changes

array

No comments found.

false

-

     └─created

string

No comments found.

false

-

     └─user

object

No comments found.

false

-

          └─id

string

No comments found.

false

-

          └─name

string

No comments found.

false

-

token

string

No comments found.

false

-

forcesavetype

int32

No comments found.

false

-

status

int32

No comments found.

false

-

users

array

No comments found.

false

-

actions

array

No comments found.

false

-

└─userid

string

No comments found.

false

-

└─type

enum

No comments found.
[Enum values:
edit()
review()
view()
embedded()
filter()
comment()
fillForms()
blockcontent()
]

false

-

userdata

string

No comments found.

false

-

lastsave

string

No comments found.

false

-

notmodified

boolean

No comments found.

false

-

Request-example:

curl -X GET -H 'Content-Type: application/json' -H 'Authorization' -i /api/office/callBackPro?fileId=679&oldFileId=788 --data '{
  "filetype": "skn7im",
  "url": "www.lauretta-parisian.org",
  "key": "d0hwkt",
  "changesurl": "www.lauretta-parisian.org",
  "history": {
    "serverVersion": "0.39",
    "key": "cf266l",
    "version": 752,
    "created": "1lyx8a",
    "user": {
      "id": "196",
      "name": "gil.paucek",
      "group": "v07zp5"
    },
    "changes": [
      {
        "created": "2uukca",
        "user": {
          "id": "196",
          "name": "gil.paucek"
        }
      }
    ]
  },
  "token": "tysfkz",
  "forcesavetype": 167,
  "status": 329,
  "users": [
    "7ktsnz"
  ],
  "actions": [
    {
      "userid": "196",
      "type": "edit"
    }
  ],
  "userdata": "muhc1x",
  "lastsave": "evlksu",
  "notmodified": true
}'

Response-example:

Return void.

16.5.编辑文档文件

Type: GET

Author: duwh

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

Description: 编辑文档文件

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

fileCode

string

文件代码

true

-

action

string

操作参数

false

-

actionLink

string

行动联系

false

-

userId

int64

No comments found.

false

-

Request-example:

curl -X GET -H 'Authorization' -i /api/office/edit?fileCode=88129&action=3xthdh&actionLink=zwfz6q&userId=276 --data '&88129&3xthdh&zwfz6q'

Response-example:

string

16.6.

Type: GET

Author: duwh

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

Description: 

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

fileCode

string

No comments found.

false

-

Request-example:

curl -X GET -H 'Authorization' -i /api/office/callBack?fileCode=88129

Response-example:

Return void.

16.7.

Type: GET

Author: duwh

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

Description: 

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Request-example:

curl -X GET -H 'Authorization' -i /api/office/index

Response-example:

string

17.附件-文件夹

17.1.新增

Type: POST

Author: duwh

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

Description: 新增

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

id

int64

No comments found.

false

-

remark

string

No comments found.

false

-

createUserId

int64

No comments found.

false

-

creator

string

记录创建者

false

-

createTime

string

No comments found.

false

-

modifyUserId

int64

No comments found.

false

-

modifyTime

string

No comments found.

false

-

deleteFlag

int32

No comments found.

false

-

ignoreWarning

boolean

No comments found.

false

-

nullFields

array

No comments found.

false

-

changeLogId

int64

No comments found.

false

-

name

string

文件夹名称

false

-

parentId

int64

父主键

false

-

Request-example:

curl -X POST -H 'Authorization' -i /api/file/folder --data 'id=39&remark=qgwlgw&createUserId=220&creator=v9y90u&createTime=2023-09-27 17:34:57&modifyUserId=615&modifyTime=2023-09-27 17:34:57&deleteFlag=0&ignoreWarning=true&nullFields=ilid39,ilid39&changeLogId=281&name=gil.paucek&parentId=637'

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "2295jy",
      "defaultMsg": "bp75f2",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "jdwthz",
      "defaultMsg": "q6mt3n",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "w2uibl",
      "defaultMsg": "har6n5",
      "context": {
        "object": "any object"
      }
    }
  ]
}

17.2.更新

Type: PUT

Author: duwh

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

Description: 更新

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

id

int64

No comments found.

false

-

remark

string

No comments found.

false

-

createUserId

int64

No comments found.

false

-

creator

string

记录创建者

false

-

createTime

string

No comments found.

false

-

modifyUserId

int64

No comments found.

false

-

modifyTime

string

No comments found.

false

-

deleteFlag

int32

No comments found.

false

-

ignoreWarning

boolean

No comments found.

false

-

nullFields

array

No comments found.

false

-

changeLogId

int64

No comments found.

false

-

name

string

文件夹名称

false

-

parentId

int64

父主键

false

-

Request-example:

curl -X PUT -H 'Authorization' -i /api/file/folder --data 'id=579&remark=wn0fpn&createUserId=840&creator=u87mag&createTime=2023-09-27 17:34:57&modifyUserId=148&modifyTime=2023-09-27 17:34:57&deleteFlag=0&ignoreWarning=true&nullFields=5zl9ei,5zl9ei&changeLogId=961&name=gil.paucek&parentId=719'

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "rmit0a",
      "defaultMsg": "c837n1",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "5ud1xq",
      "defaultMsg": "mmzc50",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "f4cc7p",
      "defaultMsg": "uqvm2d",
      "context": {
        "object": "any object"
      }
    }
  ]
}

17.3.主键查询

Type: GET

Author: duwh

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

Description: 主键查询

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Path-parameters:

ParameterTypeDescriptionRequiredSince

key

int64

关键

true

-

Request-example:

curl -X GET -H 'Authorization' -i /api/file/folder/121

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "g3sxsr",
      "defaultMsg": "vhk0a0",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "k8yc57",
      "defaultMsg": "pinlin",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "5cj2lt",
      "defaultMsg": "nrpzid",
      "context": {
        "object": "any object"
      }
    }
  ]
}

17.4.分页

Type: GET

Author: duwh

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

Description: 分页

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

current

int32

页码，默认为1

false

-

size

int32

页大小，默认为10

false

-

keyword

string

搜索关键字

false

-

idSet

object

ID

false

-

orders

array

排序

false

-

└─column

string

属性名称

false

-

└─asc

boolean

是否升序

false

-

id

int64

No comments found.

false

-

remark

string

No comments found.

false

-

createUserId

int64

No comments found.

false

-

loginUserId

int64

登录用户id 用于数据权限

false

-

createTimeStart

string

No comments found.

false

-

createTimeEnd

string

No comments found.

false

-

modifyUserId

int64

No comments found.

false

-

modifyTimeStart

string

No comments found.

false

-

modifyTimeEnd

string

No comments found.

false

-

dataPermissionFlag

boolean

No comments found.

false

-

name

string

文件夹名称

false

-

parentId

int64

父主键

false

-

Request-example:

curl -X GET -H 'Authorization' -i /api/file/folder/paging?current=976&size=10&keyword=dy888t&column=kbq99s&asc=true&id=112&remark=u74w48&createUserId=765&loginUserId=14&createTimeStart=2023-09-27 17:34:57&createTimeEnd=2023-09-27 17:34:57&modifyUserId=159&modifyTimeStart=2023-09-27 17:34:57&modifyTimeEnd=2023-09-27 17:34:57&dataPermissionFlag=true&name=gil.paucek&parentId=542&orders[0].column=dfjqny&orders[0].asc=true

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "ds8qpe",
      "defaultMsg": "f7xf1u",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "00d0zb",
      "defaultMsg": "oqwin8",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "3roqp7",
      "defaultMsg": "yi7u8h",
      "context": {
        "object": "any object"
      }
    }
  ]
}

17.5.查询列表

Type: GET

Author: duwh

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

Description: 查询列表

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

current

int32

页码，默认为1

false

-

size

int32

页大小，默认为10

false

-

keyword

string

搜索关键字

false

-

idSet

object

ID

false

-

orders

array

排序

false

-

└─column

string

属性名称

false

-

└─asc

boolean

是否升序

false

-

id

int64

No comments found.

false

-

remark

string

No comments found.

false

-

createUserId

int64

No comments found.

false

-

loginUserId

int64

登录用户id 用于数据权限

false

-

createTimeStart

string

No comments found.

false

-

createTimeEnd

string

No comments found.

false

-

modifyUserId

int64

No comments found.

false

-

modifyTimeStart

string

No comments found.

false

-

modifyTimeEnd

string

No comments found.

false

-

dataPermissionFlag

boolean

No comments found.

false

-

name

string

文件夹名称

false

-

parentId

int64

父主键

false

-

Request-example:

curl -X GET -H 'Authorization' -i /api/file/folder/list?current=729&size=10&keyword=5ee6lj&column=3lw2g6&asc=true&id=724&remark=to7dgb&createUserId=175&loginUserId=371&createTimeStart=2023-09-27 17:34:57&createTimeEnd=2023-09-27 17:34:57&modifyUserId=870&modifyTimeStart=2023-09-27 17:34:57&modifyTimeEnd=2023-09-27 17:34:57&dataPermissionFlag=true&name=gil.paucek&parentId=201&orders[0].asc=true&orders[0].column=0wo0r7

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "gfzbnc",
      "defaultMsg": "jukll8",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "9pem23",
      "defaultMsg": "1bmhli",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "xi0gzg",
      "defaultMsg": "e00f1u",
      "context": {
        "object": "any object"
      }
    }
  ]
}

17.6.删除

Type: DELETE

Author: duwh

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

Description: 删除

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

keys

array

主键id,[array of int64]

false

-

Request-example:

curl -X DELETE -H 'Authorization' -i /api/file/folder/deleteSoft?keys=vukkw9&keys=vukkw9

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "6m5pvn",
      "defaultMsg": "22biwj",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "c74lxb",
      "defaultMsg": "f6ddgi",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "flvul1",
      "defaultMsg": "wbdbk7",
      "context": {
        "object": "any object"
      }
    }
  ]
}

18.附件-文件

18.1.上传文件

Type: POST

Author: duwh

Content-Type: multipart/form-data

Description: 上传文件

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

name

string

名字

false

-

folderId

int64

No comments found.

false

-

file

file

文件

true

-

Request-example:

curl -X POST -H 'Content-Type: multipart/form-data' -H 'Authorization' -F 'file=' -i /api/file/file/upload --data 'name=gil.paucek&folderId=320'

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "271mv1",
      "defaultMsg": "g4pkgi",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "m4439d",
      "defaultMsg": "tdl6me",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "ikcydd",
      "defaultMsg": "2lsgxt",
      "context": {
        "object": "any object"
      }
    }
  ]
}

18.2.上传照片

Type: POST

Author: duwh

Content-Type: multipart/form-data

Description: 上传照片

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

folderId

int64

文件夹id

true

-

file

file

文件

true

-

Request-example:

curl -X POST -H 'Content-Type: multipart/form-data' -H 'Authorization' -F 'file=' -i /api/file/file/pictures --data 'folderId=399'

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "3ry66q",
      "defaultMsg": "quldru",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "x7u7kx",
      "defaultMsg": "0704a2",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "b815u3",
      "defaultMsg": "4xsynm",
      "context": {
        "object": "any object"
      }
    }
  ]
}

18.3.主键查询

Type: GET

Author: duwh

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

Description: 主键查询

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Path-parameters:

ParameterTypeDescriptionRequiredSince

key

int64

关键

true

-

Request-example:

curl -X GET -H 'Authorization' -i /api/file/file/295

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "em149h",
      "defaultMsg": "f379jf",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "fxxfje",
      "defaultMsg": "bpmwrl",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "oy7ar3",
      "defaultMsg": "kv0wlo",
      "context": {
        "object": "any object"
      }
    }
  ]
}

18.4.分页

Type: GET

Author: duwh

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

Description: 分页

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

current

int32

页码，默认为1

false

-

size

int32

页大小，默认为10

false

-

keyword

string

搜索关键字

false

-

idSet

object

ID

false

-

orders

array

排序

false

-

└─column

string

属性名称

false

-

└─asc

boolean

是否升序

false

-

id

int64

No comments found.

false

-

remark

string

No comments found.

false

-

createUserId

int64

No comments found.

false

-

loginUserId

int64

登录用户id 用于数据权限

false

-

createTimeStart

string

No comments found.

false

-

createTimeEnd

string

No comments found.

false

-

modifyUserId

int64

No comments found.

false

-

modifyTimeStart

string

No comments found.

false

-

modifyTimeEnd

string

No comments found.

false

-

dataPermissionFlag

boolean

No comments found.

false

-

folderId

int64

文件夹主键

false

-

name

string

文件名称

false

-

fileName

string

原文件名称

false

-

realName

string

真实文件名

false

-

serverPath

string

文件路径

false

-

suffix

string

格式后缀

false

-

fileType

string

文件类型

false

-

fileTypeDesc

string

文件类型desc

false

-

fileSize

int64

文件大小(字节)

false

-

versionId

int64

最新版本主键

false

-

versionNo

string

最新版本号

false

-

versionFlag

int32

版本标记 版本文件，0：非版本文件，1：版本文件

false

-

Request-example:

curl -X GET -H 'Authorization' -i /api/file/file/paging?current=50&size=10&keyword=m33jep&column=knvxce&asc=true&id=498&remark=jxf0hs&createUserId=91&loginUserId=634&createTimeStart=2023-09-27 17:34:57&createTimeEnd=2023-09-27 17:34:57&modifyUserId=596&modifyTimeStart=2023-09-27 17:34:57&modifyTimeEnd=2023-09-27 17:34:57&dataPermissionFlag=true&folderId=595&name=gil.paucek&fileName=gil.paucek&realName=gil.paucek&serverPath=umxnki&suffix=mtngrk&fileType=0ubiuq&fileTypeDesc=ij32qj&fileSize=318&versionId=944&versionNo=diivno&versionFlag=0&orders[0].asc=true&orders[0].column=24uu1m

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "mnfu0k",
      "defaultMsg": "2v9a4s",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "quzph4",
      "defaultMsg": "u4nmkl",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "7ladrl",
      "defaultMsg": "bh9nz3",
      "context": {
        "object": "any object"
      }
    }
  ]
}

18.5.查询列表

Type: GET

Author: duwh

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

Description: 查询列表

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

current

int32

页码，默认为1

false

-

size

int32

页大小，默认为10

false

-

keyword

string

搜索关键字

false

-

idSet

object

ID

false

-

orders

array

排序

false

-

└─column

string

属性名称

false

-

└─asc

boolean

是否升序

false

-

id

int64

No comments found.

false

-

remark

string

No comments found.

false

-

createUserId

int64

No comments found.

false

-

loginUserId

int64

登录用户id 用于数据权限

false

-

createTimeStart

string

No comments found.

false

-

createTimeEnd

string

No comments found.

false

-

modifyUserId

int64

No comments found.

false

-

modifyTimeStart

string

No comments found.

false

-

modifyTimeEnd

string

No comments found.

false

-

dataPermissionFlag

boolean

No comments found.

false

-

folderId

int64

文件夹主键

false

-

name

string

文件名称

false

-

fileName

string

原文件名称

false

-

realName

string

真实文件名

false

-

serverPath

string

文件路径

false

-

suffix

string

格式后缀

false

-

fileType

string

文件类型

false

-

fileTypeDesc

string

文件类型desc

false

-

fileSize

int64

文件大小(字节)

false

-

versionId

int64

最新版本主键

false

-

versionNo

string

最新版本号

false

-

versionFlag

int32

版本标记 版本文件，0：非版本文件，1：版本文件

false

-

Request-example:

curl -X GET -H 'Authorization' -i /api/file/file/list?current=298&size=10&keyword=g54zyu&column=ozrs4a&asc=true&id=522&remark=ry19bx&createUserId=663&loginUserId=799&createTimeStart=2023-09-27 17:34:57&createTimeEnd=2023-09-27 17:34:57&modifyUserId=393&modifyTimeStart=2023-09-27 17:34:57&modifyTimeEnd=2023-09-27 17:34:57&dataPermissionFlag=true&folderId=653&name=gil.paucek&fileName=gil.paucek&realName=gil.paucek&serverPath=6k6j2u&suffix=9onozi&fileType=qqy0dt&fileTypeDesc=sprqs9&fileSize=463&versionId=670&versionNo=9wu885&versionFlag=0&orders[0].column=wrbn5g&orders[0].asc=true

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "bq3pt5",
      "defaultMsg": "5ewr67",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "2y7qab",
      "defaultMsg": "ttbuwc",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "9c4f6p",
      "defaultMsg": "7s9e9g",
      "context": {
        "object": "any object"
      }
    }
  ]
}

18.6.删除

Type: DELETE

Author: duwh

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

Description: 删除

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

keys

array

主键id,[array of int64]

false

-

Request-example:

curl -X DELETE -H 'Authorization' -i /api/file/file/deleteSoft?keys=mvo5or&keys=mvo5or

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "5kgv8m",
      "defaultMsg": "1gwzbz",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "pcegsj",
      "defaultMsg": "hp0cs3",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "5mtaeb",
      "defaultMsg": "w57mr0",
      "context": {
        "object": "any object"
      }
    }
  ]
}

18.7.预览

Type: GET

Author: duwh

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

Description: 预览

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Path-parameters:

ParameterTypeDescriptionRequiredSince

key

int64

关键

true

-

Request-example:

curl -X GET -H 'Authorization' -i /api/file/file/preview/511

Response-fields:

FieldTypeDescriptionSince

any object

object

any object.

-

Response-example:

{}

18.8.下载

Type: GET

Author: duwh

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

Description: 下载

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Path-parameters:

ParameterTypeDescriptionRequiredSince

key

int64

关键

true

-

Request-example:

curl -X GET -H 'Authorization' -i /api/file/file/download/849

Response-example:

File download.

19.开票信息管理

19.1.新建

Type: POST

Author: carl.wang

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

Description: 新建

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

id

int64

No comments found.

false

-

remark

string

No comments found.

false

-

createUserId

int64

No comments found.

false

-

creator

string

记录创建者

false

-

createTime

string

No comments found.

false

-

modifyUserId

int64

No comments found.

false

-

modifyTime

string

No comments found.

false

-

deleteFlag

int32

No comments found.

false

-

ignoreWarning

boolean

No comments found.

false

-

nullFields

array

No comments found.

false

-

changeLogId

int64

No comments found.

false

-

bookId

int64

地址簿id

false

-

invoiceMessage

string

发票信息

false

-

invoiceTitle

string

发票抬头

false

-

taxRete

string

税率

false

-

taxNo

string

税号

false

-

invoiceType

string

开票类型

false

-

invoiceAddress

string

开票地址

false

-

invoicePhone

string

电话

false

-

depositBank

string

开户行

false

-

invoiceAccount

string

账户

false

-

currency

string

币种

false

-

defaultFlag

boolean

默认

false

-

objectType

string

主档类型（客户，供应商，合作伙伴，内部公司）

false

-

Request-example:

curl -X POST -H 'Authorization' -i /api/ab/invoice/insert --data 'id=746&remark=q7ow9r&createUserId=969&creator=49cfke&createTime=2023-09-27 17:34:57&modifyUserId=341&modifyTime=2023-09-27 17:34:57&deleteFlag=0&ignoreWarning=true&nullFields=yl66bg,yl66bg&changeLogId=512&bookId=69&invoiceMessage=success&invoiceTitle=hdls84&taxRete=ajif5a&taxNo=agpg13&invoiceType=5257x0&invoiceAddress=Apt. 994 784 Tom Junction， West Francine， MS 22939&invoicePhone=(330) 530-9768&depositBank=7p03ch&invoiceAccount=wd4hbt¤cy=gmltnl&defaultFlag=true&objectType=vbcw6z'

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "axc3sz",
      "defaultMsg": "lcsim9",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "vke3hf",
      "defaultMsg": "t4b10d",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "5jrmqv",
      "defaultMsg": "lx6cz0",
      "context": {
        "object": "any object"
      }
    }
  ]
}

19.2.修改

Type: PUT

Author: carl.wang

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

Description: 修改

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

id

int64

No comments found.

false

-

remark

string

No comments found.

false

-

createUserId

int64

No comments found.

false

-

creator

string

记录创建者

false

-

createTime

string

No comments found.

false

-

modifyUserId

int64

No comments found.

false

-

modifyTime

string

No comments found.

false

-

deleteFlag

int32

No comments found.

false

-

ignoreWarning

boolean

No comments found.

false

-

nullFields

array

No comments found.

false

-

changeLogId

int64

No comments found.

false

-

bookId

int64

地址簿id

false

-

invoiceMessage

string

发票信息

false

-

invoiceTitle

string

发票抬头

false

-

taxRete

string

税率

false

-

taxNo

string

税号

false

-

invoiceType

string

开票类型

false

-

invoiceAddress

string

开票地址

false

-

invoicePhone

string

电话

false

-

depositBank

string

开户行

false

-

invoiceAccount

string

账户

false

-

currency

string

币种

false

-

defaultFlag

boolean

默认

false

-

objectType

string

主档类型（客户，供应商，合作伙伴，内部公司）

false

-

Request-example:

curl -X PUT -H 'Authorization' -i /api/ab/invoice/update --data 'id=520&remark=krparf&createUserId=765&creator=6vcnac&createTime=2023-09-27 17:34:57&modifyUserId=37&modifyTime=2023-09-27 17:34:57&deleteFlag=0&ignoreWarning=true&nullFields=1c2zsn,1c2zsn&changeLogId=674&bookId=20&invoiceMessage=success&invoiceTitle=ylcpnk&taxRete=nb0nfr&taxNo=z6nq1f&invoiceType=98jtkg&invoiceAddress=Apt. 994 784 Tom Junction， West Francine， MS 22939&invoicePhone=(330) 530-9768&depositBank=u36fej&invoiceAccount=tatdiw¤cy=6m2ld6&defaultFlag=true&objectType=pyqylj'

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "n8xz6s",
      "defaultMsg": "30ojgu",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "obiegb",
      "defaultMsg": "crebex",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "m34uk0",
      "defaultMsg": "uum7u0",
      "context": {
        "object": "any object"
      }
    }
  ]
}

19.3.删除

Type: DELETE

Author: carl.wang

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

Description: 删除

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

bookId

int64

地址簿id

false

-

objectType

string

主档类型

false

-

keys

array

主键id,[array of int64]

false

-

Request-example:

curl -X DELETE -H 'Authorization' -i /api/ab/invoice/delete?bookId=5&objectType=gpn4n2&keys=3iosua&keys=3iosua

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "joae68",
      "defaultMsg": "nhp532",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "lt370e",
      "defaultMsg": "f9i2ak",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "kb7jr2",
      "defaultMsg": "imz2wc",
      "context": {
        "object": "any object"
      }
    }
  ]
}

19.4.列表查询

Type: GET

Author: carl.wang

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

Description: 列表查询

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

bookId

int64

地址薄主键

false

-

Request-example:

curl -X GET -H 'Authorization' -i /api/ab/invoice/queryList?bookId=988

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

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

锁版本

-

└─bookId

int64

地址簿id

-

└─invoiceMessage

string

发票信息

-

└─invoiceTitle

string

发票抬头

-

└─taxRete

string

税率

-

└─taxReteName

string

税率

-

└─taxNo

string

税号

-

└─invoiceType

string

开票类型

-

└─invoiceTypeName

string

开票类型

-

└─invoiceAddress

string

开票地址

-

└─invoicePhone

string

电话

-

└─depositBank

string

开户行

-

└─invoiceAccount

string

账户

-

└─currency

string

币种

-

└─currencyName

string

币种

-

└─defaultFlag

boolean

默认

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": [
    {
      "id": 973,
      "tenantId": 604,
      "remark": "ipddms",
      "createUserId": 857,
      "creator": "iw5l79",
      "createTime": "2023-09-27 17:34:57",
      "modifyUserId": 983,
      "updater": "id7v9y",
      "modifyTime": "2023-09-27 17:34:57",
      "deleteFlag": 0,
      "auditDataVersion": 533,
      "bookId": 859,
      "invoiceMessage": "success",
      "invoiceTitle": "k8650l",
      "taxRete": "2bwhk3",
      "taxReteName": "gil.paucek",
      "taxNo": "sjyyl4",
      "invoiceType": "rh43ag",
      "invoiceTypeName": "gil.paucek",
      "invoiceAddress": "Apt. 994 784 Tom Junction， West Francine， MS 22939",
      "invoicePhone": "(330) 530-9768",
      "depositBank": "1alukm",
      "invoiceAccount": "e6jpks",
      "currency": "l4hiap",
      "currencyName": "gil.paucek",
      "defaultFlag": true
    }
  ],
  "infos": [
    {
      "localeCode": "88129",
      "msg": "78jjic",
      "defaultMsg": "atpeh2",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "lhk1qz",
      "defaultMsg": "c28mex",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "v4y3n5",
      "defaultMsg": "a9p2ys",
      "context": {
        "object": "any object"
      }
    }
  ]
}

20.地址管理

20.1.新建

Type: POST

Author: carl.wang

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

Description: 新建

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

id

int64

No comments found.

false

-

remark

string

No comments found.

false

-

createUserId

int64

No comments found.

false

-

creator

string

记录创建者

false

-

createTime

string

No comments found.

false

-

modifyUserId

int64

No comments found.

false

-

modifyTime

string

No comments found.

false

-

deleteFlag

int32

No comments found.

false

-

ignoreWarning

boolean

No comments found.

false

-

nullFields

array

No comments found.

false

-

changeLogId

int64

No comments found.

false

-

bookId

int64

地址簿id

false

-

addressType

string

地址类型

false

-

country

string

国家

false

-

province

string

省

false

-

provinceName

string

省

false

-

city

string

市

false

-

cityName

string

市

false

-

district

string

区

false

-

districtName

string

区

false

-

detailAddress

string

详细地址

false

-

addressEmail

string

邮箱

false

-

objectType

string

主档类型（客户，供应商，合作伙伴，内部公司）

false

-

defaultAddress

boolean

默认地址

false

-

Request-example:

curl -X POST -H 'Authorization' -i /api/ab/address/insert --data 'id=497&remark=gitmnl&createUserId=388&creator=8kyrrg&createTime=2023-09-27 17:34:57&modifyUserId=178&modifyTime=2023-09-27 17:34:57&deleteFlag=0&ignoreWarning=true&nullFields=veql90,veql90&changeLogId=798&bookId=443&addressType=m1x7ba&country=obo44s&province=hvhnqk&provinceName=gil.paucek&city=79jg9l&cityName=gil.paucek&district=12oetc&districtName=gil.paucek&detailAddress=Apt. 994 784 Tom Junction， West Francine， MS 22939&addressEmail=maple.huel@hotmail.com&objectType=vkexkn&defaultAddress=true'

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "p29mtb",
      "defaultMsg": "tmlz6m",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "ok4jwx",
      "defaultMsg": "jcb1i3",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "awvwny",
      "defaultMsg": "g4is5y",
      "context": {
        "object": "any object"
      }
    }
  ]
}

20.2.修改

Type: PUT

Author: carl.wang

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

Description: 修改

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

id

int64

No comments found.

false

-

remark

string

No comments found.

false

-

createUserId

int64

No comments found.

false

-

creator

string

记录创建者

false

-

createTime

string

No comments found.

false

-

modifyUserId

int64

No comments found.

false

-

modifyTime

string

No comments found.

false

-

deleteFlag

int32

No comments found.

false

-

ignoreWarning

boolean

No comments found.

false

-

nullFields

array

No comments found.

false

-

changeLogId

int64

No comments found.

false

-

bookId

int64

地址簿id

false

-

addressType

string

地址类型

false

-

country

string

国家

false

-

province

string

省

false

-

provinceName

string

省

false

-

city

string

市

false

-

cityName

string

市

false

-

district

string

区

false

-

districtName

string

区

false

-

detailAddress

string

详细地址

false

-

addressEmail

string

邮箱

false

-

objectType

string

主档类型（客户，供应商，合作伙伴，内部公司）

false

-

defaultAddress

boolean

默认地址

false

-

Request-example:

curl -X PUT -H 'Authorization' -i /api/ab/address/update --data 'id=137&remark=lgimso&createUserId=348&creator=b5s522&createTime=2023-09-27 17:34:57&modifyUserId=401&modifyTime=2023-09-27 17:34:57&deleteFlag=0&ignoreWarning=true&nullFields=j35svg,j35svg&changeLogId=913&bookId=877&addressType=gcvujj&country=arkzus&province=ft9dj2&provinceName=gil.paucek&city=4p72t0&cityName=gil.paucek&district=hm32ku&districtName=gil.paucek&detailAddress=Apt. 994 784 Tom Junction， West Francine， MS 22939&addressEmail=maple.huel@hotmail.com&objectType=td2q6q&defaultAddress=true'

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "8i0xex",
      "defaultMsg": "mmmjss",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "z4rl8x",
      "defaultMsg": "f5kyv0",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "i53ry9",
      "defaultMsg": "fvprzp",
      "context": {
        "object": "any object"
      }
    }
  ]
}

20.3.删除

Type: DELETE

Author: carl.wang

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

Description: 删除

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

bookId

int64

地址簿id

false

-

objectType

string

主档类型

false

-

keys

array

主键id,[array of int64]

false

-

Request-example:

curl -X DELETE -H 'Authorization' -i /api/ab/address/delete?bookId=64&objectType=dy67v1&keys=yvgwgs&keys=yvgwgs

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "zz87es",
      "defaultMsg": "ptbugg",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "1cqz0i",
      "defaultMsg": "c8ausb",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "2l4pwu",
      "defaultMsg": "tg96xi",
      "context": {
        "object": "any object"
      }
    }
  ]
}

20.4.列表查询

Type: GET

Author: carl.wang

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

Description: 列表查询

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

bookId

int64

地址薄主键

false

-

Request-example:

curl -X GET -H 'Authorization' -i /api/ab/address/queryList?bookId=541

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

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

锁版本

-

└─bookId

int64

地址簿id

-

└─addressType

string

地址类型

-

└─addressTypeName

string

地址类型

-

└─country

string

国家

-

└─countryName

string

No comments found.

-

└─province

string

省

-

└─provinceName

string

省

-

└─city

string

市

-

└─cityName

string

市

-

└─district

string

区

-

└─districtName

string

区

-

└─detailAddress

string

详细地址

-

└─addressEmail

string

邮箱

-

└─defaultAddress

boolean

默认地址

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": [
    {
      "id": 79,
      "tenantId": 921,
      "remark": "yvmbn2",
      "createUserId": 724,
      "creator": "jh55bz",
      "createTime": "2023-09-27 17:34:57",
      "modifyUserId": 950,
      "updater": "w0z92c",
      "modifyTime": "2023-09-27 17:34:57",
      "deleteFlag": 0,
      "auditDataVersion": 389,
      "bookId": 305,
      "addressType": "bjlam3",
      "addressTypeName": "gil.paucek",
      "country": "bids30",
      "countryName": "gil.paucek",
      "province": "328fyf",
      "provinceName": "gil.paucek",
      "city": "kly6ax",
      "cityName": "gil.paucek",
      "district": "vm0p79",
      "districtName": "gil.paucek",
      "detailAddress": "Apt. 994 784 Tom Junction， West Francine， MS 22939",
      "addressEmail": "maple.huel@hotmail.com",
      "defaultAddress": true
    }
  ],
  "infos": [
    {
      "localeCode": "88129",
      "msg": "6oo8sl",
      "defaultMsg": "t0jcz3",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "on4lqm",
      "defaultMsg": "ce2kx5",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "sxd4x0",
      "defaultMsg": "mbs2y7",
      "context": {
        "object": "any object"
      }
    }
  ]
}

21.银行账户管理

21.1.银行账户新建

Type: POST

Author: carl.wang

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

Description: 银行账户新建

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

id

int64

No comments found.

false

-

remark

string

No comments found.

false

-

createUserId

int64

No comments found.

false

-

creator

string

记录创建者

false

-

createTime

string

No comments found.

false

-

modifyUserId

int64

No comments found.

false

-

modifyTime

string

No comments found.

false

-

deleteFlag

int32

No comments found.

false

-

ignoreWarning

boolean

No comments found.

false

-

nullFields

array

No comments found.

false

-

changeLogId

int64

No comments found.

false

-

bookId

int64

地址簿id

false

-

accountType

string

账户类型

false

-

depositBank

string

银行

false

-

depositCity

string

开户地

false

-

depositBankOutlet

string

开户网点

false

-

accountName

string

户名

false

-

accountNo

string

账号

false

-

currency

string

币种

false

-

defaultFlag

boolean

默认

false

-

objectType

string

主档类型（客户，供应商，合作伙伴，内部公司）

false

-

Request-example:

curl -X POST -H 'Authorization' -i /api/ab/account/insert --data 'id=378&remark=noorha&createUserId=430&creator=frv9tb&createTime=2023-09-27 17:34:57&modifyUserId=651&modifyTime=2023-09-27 17:34:57&deleteFlag=0&ignoreWarning=true&nullFields=1u40gk,1u40gk&changeLogId=315&bookId=730&accountType=ni2vok&depositBank=dpesg2&depositCity=raarh6&depositBankOutlet=d79ro1&accountName=gil.paucek&accountNo=vkn2ag¤cy=slvcw4&defaultFlag=true&objectType=2gvy1e'

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "cmnidj",
      "defaultMsg": "0zkiqd",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "ol4yvq",
      "defaultMsg": "3mggfi",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "wm70mu",
      "defaultMsg": "axpyud",
      "context": {
        "object": "any object"
      }
    }
  ]
}

21.2.修改

Type: PUT

Author: carl.wang

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

Description: 修改

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

id

int64

No comments found.

false

-

remark

string

No comments found.

false

-

createUserId

int64

No comments found.

false

-

creator

string

记录创建者

false

-

createTime

string

No comments found.

false

-

modifyUserId

int64

No comments found.

false

-

modifyTime

string

No comments found.

false

-

deleteFlag

int32

No comments found.

false

-

ignoreWarning

boolean

No comments found.

false

-

nullFields

array

No comments found.

false

-

changeLogId

int64

No comments found.

false

-

bookId

int64

地址簿id

false

-

accountType

string

账户类型

false

-

depositBank

string

银行

false

-

depositCity

string

开户地

false

-

depositBankOutlet

string

开户网点

false

-

accountName

string

户名

false

-

accountNo

string

账号

false

-

currency

string

币种

false

-

defaultFlag

boolean

默认

false

-

objectType

string

主档类型（客户，供应商，合作伙伴，内部公司）

false

-

Request-example:

curl -X PUT -H 'Authorization' -i /api/ab/account/update --data 'id=576&remark=0xow58&createUserId=938&creator=tlu96y&createTime=2023-09-27 17:34:57&modifyUserId=950&modifyTime=2023-09-27 17:34:57&deleteFlag=0&ignoreWarning=true&nullFields=upng1s,upng1s&changeLogId=136&bookId=16&accountType=ihjum3&depositBank=39tkc3&depositCity=y6ioy1&depositBankOutlet=b0d632&accountName=gil.paucek&accountNo=1q5cjf¤cy=bc8k2e&defaultFlag=true&objectType=ptix7x'

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "6ienbt",
      "defaultMsg": "9pzf3j",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "pdaxs6",
      "defaultMsg": "egxkwi",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "m582cu",
      "defaultMsg": "wqyh45",
      "context": {
        "object": "any object"
      }
    }
  ]
}

21.3.删除

Type: DELETE

Author: carl.wang

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

Description: 删除

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

bookId

int64

地址簿id

false

-

objectType

string

主档类型

false

-

keys

array

主键id,[array of int64]

false

-

Request-example:

curl -X DELETE -H 'Authorization' -i /api/ab/account/delete?bookId=219&objectType=7t04b4&keys=azy82y&keys=azy82y

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "8haxyn",
      "defaultMsg": "y93upv",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "hnm4tg",
      "defaultMsg": "1dwp59",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "ck7eoi",
      "defaultMsg": "deobua",
      "context": {
        "object": "any object"
      }
    }
  ]
}

21.4.列表查询

Type: GET

Author: carl.wang

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

Description: 列表查询

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

bookId

int64

地址薄主键

false

-

Request-example:

curl -X GET -H 'Authorization' -i /api/ab/account/queryList?bookId=178

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "y3sx4m",
      "defaultMsg": "7lys9z",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "a223kt",
      "defaultMsg": "z5er9a",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "pp6krn",
      "defaultMsg": "hxiw0b",
      "context": {
        "object": "any object"
      }
    }
  ]
}

22.联系人管理

22.1.新建

Type: POST

Author: carl.wang

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

Description: 新建

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

id

int64

No comments found.

false

-

remark

string

No comments found.

false

-

createUserId

int64

No comments found.

false

-

creator

string

记录创建者

false

-

createTime

string

No comments found.

false

-

modifyUserId

int64

No comments found.

false

-

modifyTime

string

No comments found.

false

-

deleteFlag

int32

No comments found.

false

-

ignoreWarning

boolean

No comments found.

false

-

nullFields

array

No comments found.

false

-

changeLogId

int64

No comments found.

false

-

bookId

int64

地址簿id

false

-

contactsStatus

string

联系人状态

false

-

contactsType

string

联系人类型

false

-

contactsName

string

联系人姓名

false

-

contactsPhone

string

联系人手机

false

-

contactsTelephone

string

联系人电话

false

-

contactsEmail

string

邮箱

false

-

contactsAddress

string

联系地址

false

-

socialAccountType

string

社交账户类型

false

-

socialAccount

string

社交账户

false

-

contactsDepartment

string

部门

false

-

contactsPosition

string

岗位

false

-

sex

string

性别

false

-

birthday

string

生日

false

-

isKeyPerson

boolean

是否是关键决策人

false

-

objectType

string

主档类型（客户，供应商，合作伙伴，内部公司）

false

-

Request-example:

curl -X POST -H 'Authorization' -i /api/ab/contacts/insert --data 'id=786&remark=jf5yfb&createUserId=810&creator=ha2ve1&createTime=2023-09-27 17:34:57&modifyUserId=520&modifyTime=2023-09-27 17:34:57&deleteFlag=0&ignoreWarning=true&nullFields=chw942,chw942&changeLogId=963&bookId=297&contactsStatus=8vsefo&contactsType=lhfdmt&contactsName=gil.paucek&contactsPhone=(330) 530-9768&contactsTelephone=(330) 530-9768&contactsEmail=maple.huel@hotmail.com&contactsAddress=Apt. 994 784 Tom Junction， West Francine， MS 22939&socialAccountType=1qg621&socialAccount=t5l2kn&contactsDepartment=rjo1ys&contactsPosition=awqtfd&sex=ifzlwt&birthday=2023-09-27&isKeyPerson=true&objectType=xijnvx'

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "dmgkls",
      "defaultMsg": "5abz63",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "p1gaau",
      "defaultMsg": "0tpt9n",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "4y7eah",
      "defaultMsg": "0okx0o",
      "context": {
        "object": "any object"
      }
    }
  ]
}

22.2.修改

Type: PUT

Author: carl.wang

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

Description: 修改

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

id

int64

No comments found.

false

-

remark

string

No comments found.

false

-

createUserId

int64

No comments found.

false

-

creator

string

记录创建者

false

-

createTime

string

No comments found.

false

-

modifyUserId

int64

No comments found.

false

-

modifyTime

string

No comments found.

false

-

deleteFlag

int32

No comments found.

false

-

ignoreWarning

boolean

No comments found.

false

-

nullFields

array

No comments found.

false

-

changeLogId

int64

No comments found.

false

-

bookId

int64

地址簿id

false

-

contactsStatus

string

联系人状态

false

-

contactsType

string

联系人类型

false

-

contactsName

string

联系人姓名

false

-

contactsPhone

string

联系人手机

false

-

contactsTelephone

string

联系人电话

false

-

contactsEmail

string

邮箱

false

-

contactsAddress

string

联系地址

false

-

socialAccountType

string

社交账户类型

false

-

socialAccount

string

社交账户

false

-

contactsDepartment

string

部门

false

-

contactsPosition

string

岗位

false

-

sex

string

性别

false

-

birthday

string

生日

false

-

isKeyPerson

boolean

是否是关键决策人

false

-

objectType

string

主档类型（客户，供应商，合作伙伴，内部公司）

false

-

Request-example:

curl -X PUT -H 'Authorization' -i /api/ab/contacts/update --data 'id=331&remark=4p744n&createUserId=667&creator=did54c&createTime=2023-09-27 17:34:58&modifyUserId=931&modifyTime=2023-09-27 17:34:58&deleteFlag=0&ignoreWarning=true&nullFields=f8cq0u,f8cq0u&changeLogId=358&bookId=46&contactsStatus=6f5ts5&contactsType=ukrgjd&contactsName=gil.paucek&contactsPhone=(330) 530-9768&contactsTelephone=(330) 530-9768&contactsEmail=maple.huel@hotmail.com&contactsAddress=Apt. 994 784 Tom Junction， West Francine， MS 22939&socialAccountType=zhnr19&socialAccount=kepbem&contactsDepartment=frnyqi&contactsPosition=m17n2y&sex=1lyqyc&birthday=2023-09-27&isKeyPerson=true&objectType=v8eiyz'

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "qa841v",
      "defaultMsg": "snajxu",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "y8ycih",
      "defaultMsg": "y1dbgf",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "ya024r",
      "defaultMsg": "8il7yh",
      "context": {
        "object": "any object"
      }
    }
  ]
}

22.3.分页查询

Type: GET

Author: carl.wang

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

Description: 分页查询

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

current

int32

页码，默认为1

false

-

size

int32

页大小，默认为10

false

-

keyword

string

搜索关键字

false

-

idSet

object

ID

false

-

orders

array

排序

false

-

└─column

string

属性名称

false

-

└─asc

boolean

是否升序

false

-

id

int64

No comments found.

false

-

remark

string

No comments found.

false

-

createUserId

int64

No comments found.

false

-

loginUserId

int64

登录用户id 用于数据权限

false

-

createTimeStart

string

No comments found.

false

-

createTimeEnd

string

No comments found.

false

-

modifyUserId

int64

No comments found.

false

-

modifyTimeStart

string

No comments found.

false

-

modifyTimeEnd

string

No comments found.

false

-

dataPermissionFlag

boolean

No comments found.

false

-

contactsIds

array

联系人id列表

false

-

bookId

int64

地址簿id

false

-

contactsType

string

联系人类型

false

-

contactsName

string

联系人姓名

false

-

contactsStatus

string

联系人姓名

false

-

isKeyPerson

boolean

是否是关键决策人

false

-

Request-example:

curl -X GET -H 'Authorization' -i /api/ab/contacts/paging?current=563&size=10&keyword=lw8wsk&column=ed6z06&asc=true&id=382&remark=9hhz5i&createUserId=182&loginUserId=569&createTimeStart=2023-09-27 17:34:58&createTimeEnd=2023-09-27 17:34:58&modifyUserId=923&modifyTimeStart=2023-09-27 17:34:58&modifyTimeEnd=2023-09-27 17:34:58&dataPermissionFlag=true&contactsIds=345,345&bookId=204&contactsType=qx1x5u&contactsName=gil.paucek&contactsStatus=eatyl4&isKeyPerson=true&orders[0].column=0ojxww&orders[0].asc=true

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "acbktw",
      "defaultMsg": "tsdve5",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "n6t642",
      "defaultMsg": "li1txe",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "lcylu4",
      "defaultMsg": "0c5i46",
      "context": {
        "object": "any object"
      }
    }
  ]
}

22.4.详情查询

Type: GET

Author: carl.wang

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

Description: 详情查询

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Path-parameters:

ParameterTypeDescriptionRequiredSince

id

int64

主键

true

-

Request-example:

curl -X GET -H 'Authorization' -i /api/ab/contacts/queryByKey/982

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "smdveb",
      "defaultMsg": "00v4vl",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "enjbla",
      "defaultMsg": "8b2kqh",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "dy1bpr",
      "defaultMsg": "p6lgfp",
      "context": {
        "object": "any object"
      }
    }
  ]
}

22.5.删除

Type: DELETE

Author: carl.wang

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

Description: 删除

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

bookId

int64

地址簿id

false

-

objectType

string

主档类型

false

-

keys

array

主键id,[array of int64]

false

-

Request-example:

curl -X DELETE -H 'Authorization' -i /api/ab/contacts/delete?bookId=635&objectType=46gh8l&keys=lbtii7&keys=lbtii7

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "k0jlh8",
      "defaultMsg": "m7ijwm",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "eytnse",
      "defaultMsg": "3rzd64",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "vpmpd4",
      "defaultMsg": "cxayw9",
      "context": {
        "object": "any object"
      }
    }
  ]
}

22.6.修改激活暂挂状态

Type: GET

Author: carl.wang

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

Description: 修改激活暂挂状态

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

key

int64

主键

false

-

contactsStatus

string

状态

false

-

Request-example:

curl -X GET -H 'Authorization' -i /api/ab/act/updateStatus?key=630&contactsStatus=740fl9

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "hbxeko",
      "defaultMsg": "znnsy2",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "2v6885",
      "defaultMsg": "as2osz",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "pxhv6o",
      "defaultMsg": "uclb3l",
      "context": {
        "object": "any object"
      }
    }
  ]
}

22.7.列表查询

Type: GET

Author: carl.wang

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

Description: 列表查询

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

bookId

int64

地址薄主键

false

-

Request-example:

curl -X GET -H 'Authorization' -i /api/ab/contacts/queryList?bookId=478

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "x8ke5v",
      "defaultMsg": "547ho0",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "yubl75",
      "defaultMsg": "24tind",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "xam0ti",
      "defaultMsg": "wc85yv",
      "context": {
        "object": "any object"
      }
    }
  ]
}

22.8.查询修改记录

Type: GET

Author: carl.wang

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

Description: 查询修改记录

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

current

int32

页码，默认为1

false

-

size

int32

页大小，默认为10

false

-

keyword

string

搜索关键字

false

-

idSet

object

ID

false

-

orders

array

排序

false

-

└─column

string

属性名称

false

-

└─asc

boolean

是否升序

false

-

id

int64

No comments found.

false

-

remark

string

No comments found.

false

-

createUserId

int64

No comments found.

false

-

loginUserId

int64

登录用户id 用于数据权限

false

-

createTimeStart

string

No comments found.

false

-

createTimeEnd

string

No comments found.

false

-

modifyUserId

int64

No comments found.

false

-

modifyTimeStart

string

No comments found.

false

-

modifyTimeEnd

string

No comments found.

false

-

dataPermissionFlag

boolean

No comments found.

false

-

objectId

int64

业务主键

false

-

logObject

string

日志类型

false

-

logContent

string

日志内容

false

-

Request-example:

curl -X GET -H 'Authorization' -i /api/ab/contacts/queryLogList?current=658&size=10&keyword=aj33go&column=xh75q9&asc=true&id=361&remark=0osj8x&createUserId=718&loginUserId=710&createTimeStart=2023-09-27 17:34:58&createTimeEnd=2023-09-27 17:34:58&modifyUserId=516&modifyTimeStart=2023-09-27 17:34:58&modifyTimeEnd=2023-09-27 17:34:58&dataPermissionFlag=true&objectId=348&logObject=9c1flz&logContent=uufv88&orders[0].column=frjw20&orders[0].asc=true

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "6i11yx",
      "defaultMsg": "qtt70s",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "cbaraq",
      "defaultMsg": "7hv3kx",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "aij5m8",
      "defaultMsg": "rwul8l",
      "context": {
        "object": "any object"
      }
    }
  ]
}

22.9.批量导出excel

Type: GET

Author: carl.wang

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

Description: 批量导出excel

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

current

int32

页码，默认为1

false

-

size

int32

页大小，默认为10

false

-

keyword

string

搜索关键字

false

-

idSet

object

ID

false

-

orders

array

排序

false

-

└─column

string

属性名称

false

-

└─asc

boolean

是否升序

false

-

id

int64

No comments found.

false

-

remark

string

No comments found.

false

-

createUserId

int64

No comments found.

false

-

loginUserId

int64

登录用户id 用于数据权限

false

-

createTimeStart

string

No comments found.

false

-

createTimeEnd

string

No comments found.

false

-

modifyUserId

int64

No comments found.

false

-

modifyTimeStart

string

No comments found.

false

-

modifyTimeEnd

string

No comments found.

false

-

dataPermissionFlag

boolean

No comments found.

false

-

contactsIds

array

联系人id列表

false

-

bookId

int64

地址簿id

false

-

contactsType

string

联系人类型

false

-

contactsName

string

联系人姓名

false

-

contactsStatus

string

联系人姓名

false

-

isKeyPerson

boolean

是否是关键决策人

false

-

Request-example:

curl -X GET -H 'Authorization' -i /api/ab/contacts/batchExport?current=975&size=10&keyword=u3735i&column=h40mcz&asc=true&id=909&remark=0k2lhd&createUserId=343&loginUserId=270&createTimeStart=2023-09-27 17:34:58&createTimeEnd=2023-09-27 17:34:58&modifyUserId=18&modifyTimeStart=2023-09-27 17:34:58&modifyTimeEnd=2023-09-27 17:34:58&dataPermissionFlag=true&contactsIds=68,68&bookId=624&contactsType=0pea3w&contactsName=gil.paucek&contactsStatus=flgle1&isKeyPerson=true&orders[0].column=tmn4ro&orders[0].asc=true

Response-example:

Return void.

23.组织管理

23.1.新建

Type: POST

Author: wangding

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

Description: 新建

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

id

int64

No comments found.

false

-

remark

string

No comments found.

false

-

createUserId

int64

No comments found.

false

-

creator

string

记录创建者

false

-

createTime

string

No comments found.

false

-

modifyUserId

int64

No comments found.

false

-

modifyTime

string

No comments found.

false

-

deleteFlag

int32

No comments found.

false

-

ignoreWarning

boolean

No comments found.

false

-

nullFields

array

No comments found.

false

-

changeLogId

int64

No comments found.

false

-

dimensionId

int64

No comments found.

false

-

parentId

int64

No comments found.

false

-

changeId

int64

No comments found.

false

-

orgName

string

No comments found.

false

-

orgCode

string

No comments found.

false

-

orgStatus

string

No comments found.

false

-

manageId

int64

No comments found.

false

-

isBu

int32

No comments found.

false

-

sortIndex

int32

No comments found.

false

-

extString1

string

No comments found.

false

-

extString2

string

No comments found.

false

-

extString3

string

No comments found.

false

-

extString4

string

No comments found.

false

-

extString5

string

No comments found.

false

-

extString6

string

No comments found.

false

-

extString7

string

No comments found.

false

-

extString8

string

No comments found.

false

-

extString9

string

No comments found.

false

-

extString10

string

No comments found.

false

-

initTenantId

int64

通过租户初始化数据 租户id

false

-

Request-example:

curl -X POST -H 'Authorization' -i /api/org/org/insert --data 'id=689&remark=8vb2db&createUserId=178&creator=pxr1y6&createTime=2023-09-27 17:34:58&modifyUserId=400&modifyTime=2023-09-27 17:34:58&deleteFlag=0&ignoreWarning=true&nullFields=mlyr91,mlyr91&changeLogId=590&dimensionId=367&parentId=470&changeId=629&orgName=gil.paucek&orgCode=88129&orgStatus=4o70cf&manageId=445&isBu=430&sortIndex=1&extString1=vvsnmk&extString2=c0zj81&extString3=18sbv3&extString4=snkfqx&extString5=8r0xzl&extString6=3garyl&extString7=rs02tx&extString8=p5lesh&extString9=9lm63y&extString10=f83g2x&initTenantId=707'

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "8zp5sa",
      "defaultMsg": "slr37t",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "f4vqga",
      "defaultMsg": "f9to11",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "9c00l0",
      "defaultMsg": "tu9xd7",
      "context": {
        "object": "any object"
      }
    }
  ]
}

23.2.全部修改

Type: PUT

Author: wangding

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

Description: 全部修改

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

id

int64

No comments found.

false

-

remark

string

No comments found.

false

-

createUserId

int64

No comments found.

false

-

creator

string

记录创建者

false

-

createTime

string

No comments found.

false

-

modifyUserId

int64

No comments found.

false

-

modifyTime

string

No comments found.

false

-

deleteFlag

int32

No comments found.

false

-

ignoreWarning

boolean

No comments found.

false

-

nullFields

array

No comments found.

false

-

changeLogId

int64

No comments found.

false

-

dimensionId

int64

No comments found.

false

-

parentId

int64

No comments found.

false

-

changeId

int64

No comments found.

false

-

orgName

string

No comments found.

false

-

orgCode

string

No comments found.

false

-

orgStatus

string

No comments found.

false

-

manageId

int64

No comments found.

false

-

isBu

int32

No comments found.

false

-

sortIndex

int32

No comments found.

false

-

extString1

string

No comments found.

false

-

extString2

string

No comments found.

false

-

extString3

string

No comments found.

false

-

extString4

string

No comments found.

false

-

extString5

string

No comments found.

false

-

extString6

string

No comments found.

false

-

extString7

string

No comments found.

false

-

extString8

string

No comments found.

false

-

extString9

string

No comments found.

false

-

extString10

string

No comments found.

false

-

initTenantId

int64

通过租户初始化数据 租户id

false

-

Request-example:

curl -X PUT -H 'Authorization' -i /api/org/org/update --data 'id=908&remark=zp0m5v&createUserId=671&creator=ew8tlx&createTime=2023-09-27 17:34:58&modifyUserId=384&modifyTime=2023-09-27 17:34:58&deleteFlag=0&ignoreWarning=true&nullFields=ow9snp,ow9snp&changeLogId=285&dimensionId=744&parentId=927&changeId=212&orgName=gil.paucek&orgCode=88129&orgStatus=zodrii&manageId=0&isBu=114&sortIndex=1&extString1=yrtxe4&extString2=s7f1ck&extString3=ibuk71&extString4=k0nsnf&extString5=l504fr&extString6=ve73j8&extString7=mdleu4&extString8=900xj2&extString9=h4o541&extString10=cxln40&initTenantId=356'

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "wg6rwn",
      "defaultMsg": "n5egf3",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "5xlpdz",
      "defaultMsg": "8qowzq",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "klbu9g",
      "defaultMsg": "i6bbr8",
      "context": {
        "object": "any object"
      }
    }
  ]
}

23.3.修改状态

Type: PUT

Author: wangding

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

Description: 修改状态

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

id

int64

组织主键id

false

-

orgStatus

string

组织状态

false

-

Request-example:

curl -X PUT -H 'Authorization' -i /api/org/org/updateStatus --data 'id=806&orgStatus=a5c4rp'

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "oiq2vm",
      "defaultMsg": "z5gjey",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "11j91o",
      "defaultMsg": "dywqo9",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "bdkepx",
      "defaultMsg": "ibvtf2",
      "context": {
        "object": "any object"
      }
    }
  ]
}

23.4.全局修改组织树修关系

Type: PUT

Author: wangding

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

Description: 全局修改组织树修关系

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

payloadStrs

string

po集合类

false

-

Request-example:

curl -X PUT -H 'Authorization' -i /api/org/org/updateAllRef --data 'payloadStrs=b2w872'

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "ep1dvr",
      "defaultMsg": "e6utr8",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "i9tifw",
      "defaultMsg": "ypreaf",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "2ag3ou",
      "defaultMsg": "bk50ly",
      "context": {
        "object": "any object"
      }
    }
  ]
}

23.5.修改父组织

Type: PUT

Author: wangding

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

Description: 修改父组织

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

id

int64

No comments found.

false

-

remark

string

No comments found.

false

-

createUserId

int64

No comments found.

false

-

creator

string

记录创建者

false

-

createTime

string

No comments found.

false

-

modifyUserId

int64

No comments found.

false

-

modifyTime

string

No comments found.

false

-

deleteFlag

int32

No comments found.

false

-

ignoreWarning

boolean

No comments found.

false

-

nullFields

array

No comments found.

false

-

changeLogId

int64

No comments found.

false

-

dimensionId

int64

No comments found.

false

-

orgId

int64

No comments found.

false

-

parentId

int64

No comments found.

false

-

sortIndex

int32

No comments found.

false

-

Request-example:

curl -X PUT -H 'Authorization' -i /api/org/org/updateRef --data 'id=989&remark=avcgjh&createUserId=203&creator=w87pg3&createTime=2023-09-27 17:34:58&modifyUserId=57&modifyTime=2023-09-27 17:34:58&deleteFlag=0&ignoreWarning=true&nullFields=hjix4d,hjix4d&changeLogId=130&dimensionId=745&orgId=618&parentId=536&sortIndex=1'

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "kibr9k",
      "defaultMsg": "uwsx2t",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "jzkzv1",
      "defaultMsg": "76llic",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "lpztf7",
      "defaultMsg": "cfral1",
      "context": {
        "object": "any object"
      }
    }
  ]
}

23.6.组织引用

Type: PUT

Author: wangding

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

Description: 组织引用

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

id

int64

No comments found.

false

-

remark

string

No comments found.

false

-

createUserId

int64

No comments found.

false

-

creator

string

记录创建者

false

-

createTime

string

No comments found.

false

-

modifyUserId

int64

No comments found.

false

-

modifyTime

string

No comments found.

false

-

deleteFlag

int32

No comments found.

false

-

ignoreWarning

boolean

No comments found.

false

-

nullFields

array

No comments found.

false

-

changeLogId

int64

No comments found.

false

-

dimensionId

int64

No comments found.

false

-

orgId

int64

No comments found.

false

-

parentId

int64

No comments found.

false

-

sortIndex

int32

No comments found.

false

-

Request-example:

curl -X PUT -H 'Authorization' -i /api/org/org/reference --data 'id=713&remark=b04osx&createUserId=413&creator=eup781&createTime=2023-09-27 17:34:58&modifyUserId=354&modifyTime=2023-09-27 17:34:58&deleteFlag=0&ignoreWarning=true&nullFields=npuc9q,npuc9q&changeLogId=789&dimensionId=897&orgId=42&parentId=508&sortIndex=1'

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "tkcmff",
      "defaultMsg": "xy2zo3",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "o1e86v",
      "defaultMsg": "nwac06",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "686zx1",
      "defaultMsg": "oqgwvi",
      "context": {
        "object": "any object"
      }
    }
  ]
}

23.7.组织逻辑删除

Type: DELETE

Author: wangding

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

Description: 组织逻辑删除

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

dimensionId

int64

维度id

false

-

orgId

int64

组织id

false

-

Request-example:

curl -X DELETE -H 'Authorization' -i /api/org/org/delete?dimensionId=271&orgId=709

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "cwng6a",
      "defaultMsg": "3w0lvp",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "eqses9",
      "defaultMsg": "neqpdz",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "yt7i2m",
      "defaultMsg": "754a8p",
      "context": {
        "object": "any object"
      }
    }
  ]
}

23.8.根据维度id组织列表查询

Type: GET

Author: wangding

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

Description: 根据维度id组织列表查询

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

dimensionId

int64

No comments found.

false

-

Request-example:

curl -X GET -H 'Authorization' -i /api/org/org/list?dimensionId=27

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "10y0n6",
      "defaultMsg": "lnapsy",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "cebad3",
      "defaultMsg": "orgcf7",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "ojg0yf",
      "defaultMsg": "3sd1ge",
      "context": {
        "object": "any object"
      }
    }
  ]
}

23.9.分页条件查询

Type: GET

Author: wangding

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

Description: 分页条件查询

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

current

int32

页码，默认为1

false

-

size

int32

页大小，默认为10

false

-

keyword

string

搜索关键字

false

-

idSet

object

ID

false

-

orders

array

排序

false

-

└─column

string

属性名称

false

-

└─asc

boolean

是否升序

false

-

id

int64

No comments found.

false

-

remark

string

No comments found.

false

-

createUserId

int64

No comments found.

false

-

loginUserId

int64

登录用户id 用于数据权限

false

-

createTimeStart

string

No comments found.

false

-

createTimeEnd

string

No comments found.

false

-

modifyUserId

int64

No comments found.

false

-

modifyTimeStart

string

No comments found.

false

-

modifyTimeEnd

string

No comments found.

false

-

dataPermissionFlag

boolean

No comments found.

false

-

dimensionId

int64

维度id

false

-

parentId

int64

父组织id

false

-

orgName

string

组织名称

false

-

orgCode

string

组织编号

false

-

orgStatus

string

组织状态

false

-

manageId

int64

负责人ID

false

-

isBu

int32

是否bu

false

-

sortIndex

int32

排序号

false

-

Request-example:

curl -X GET -H 'Authorization' -i /api/org/org/pading?current=474&size=10&keyword=xwp6cd&column=2fqj0k&asc=true&id=142&remark=fa5jo5&createUserId=946&loginUserId=300&createTimeStart=2023-09-27 17:34:58&createTimeEnd=2023-09-27 17:34:58&modifyUserId=163&modifyTimeStart=2023-09-27 17:34:58&modifyTimeEnd=2023-09-27 17:34:58&dataPermissionFlag=true&dimensionId=999&parentId=293&orgName=gil.paucek&orgCode=88129&orgStatus=d8upkx&manageId=421&isBu=315&sortIndex=1&orders[0].column=d4bvuw&orders[0].asc=true

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "ilnfkk",
      "defaultMsg": "c5v10w",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "7d6h9b",
      "defaultMsg": "d3vv4z",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "n28jfm",
      "defaultMsg": "ahlkof",
      "context": {
        "object": "any object"
      }
    }
  ]
}

23.10.根据组织id查询组织下员工

Type: GET

Author: wangding

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

Description: 根据组织id查询组织下员工

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

orgId

int64

组织id

false

-

Request-example:

curl -X GET -H 'Authorization' -i /api/org/org/queryEmployeeRefList?orgId=177

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "fpwk1l",
      "defaultMsg": "0tgclz",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "7w8prw",
      "defaultMsg": "784lpg",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "lahd30",
      "defaultMsg": "41j3o3",
      "context": {
        "object": "any object"
      }
    }
  ]
}

23.11.查询所有可用组织

Type: GET

Author: wangding

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

Description: 查询所有可用组织

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

dimensionId

int64

维度id (不在该维度下的所有可用组织)

false

-

defaultFlag

boolean

是否取默认维度有效组织

false

-

Request-example:

curl -X GET -H 'Authorization' -i /api/org/org/queryAll?dimensionId=555&defaultFlag=true

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "ie5dtz",
      "defaultMsg": "z7enhw",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "uzzax6",
      "defaultMsg": "afrjy0",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "sixqyz",
      "defaultMsg": "mrwnf5",
      "context": {
        "object": "any object"
      }
    }
  ]
}

23.12.根据主键和维度组织详情查询

Type: GET

Author: wangding

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

Description: 根据主键和维度组织详情查询

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

dimensionId

int64

维度Id

false

-

orgId

int64

组织Id

false

-

Request-example:

curl -X GET -H 'Authorization' -i /api/org/org/detail?dimensionId=226&orgId=987

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "8fgv41",
      "defaultMsg": "ooj8jz",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "ek7sev",
      "defaultMsg": "2jlzv2",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "li52l3",
      "defaultMsg": "832kpr",
      "context": {
        "object": "any object"
      }
    }
  ]
}

23.13.添加组织员工

Type: POST

Author: wangding

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

Description: 添加组织员工

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

payloadStrs

string

PrdOrgEmployeeRefPayload类字符串

false

-

Request-example:

curl -X POST -H 'Authorization' -i /api/org/org/insertEmployee --data 'payloadStrs=wyx6bf'

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "09eby9",
      "defaultMsg": "b9ssog",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "oacaks",
      "defaultMsg": "q6f5hj",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "y9sef5",
      "defaultMsg": "y5wii2",
      "context": {
        "object": "any object"
      }
    }
  ]
}

23.14.移除组织员工

Type: PUT

Author: wangding

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

Description: 移除组织员工

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

orgId

int64

组织id

false

-

userIds

array

员工ids,[array of int64]

false

-

Request-example:

curl -X PUT -H 'Authorization' -i /api/org/org/deleteEmployee --data 'orgId=361&userIds=8owlx3&userIds=8owlx3'

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "9b6v0e",
      "defaultMsg": "t851l3",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "ipzp7r",
      "defaultMsg": "w6izqr",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "6lo021",
      "defaultMsg": "d8w0za",
      "context": {
        "object": "any object"
      }
    }
  ]
}

23.15.新建或修改组织角色

Type: PUT

Author: wangding

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

Description: 新建或修改组织角色

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

id

int64

No comments found.

false

-

remark

string

No comments found.

false

-

createUserId

int64

No comments found.

false

-

creator

string

记录创建者

false

-

createTime

string

No comments found.

false

-

modifyUserId

int64

No comments found.

false

-

modifyTime

string

No comments found.

false

-

deleteFlag

int32

No comments found.

false

-

ignoreWarning

boolean

No comments found.

false

-

nullFields

array

No comments found.

false

-

changeLogId

int64

No comments found.

false

-

orgId

int64

No comments found.

false

-

changeId

int64

No comments found.

false

-

roleName

string

No comments found.

false

-

roleCode

string

No comments found.

false

-

roleEmployees

string

No comments found.

false

-

extString1

string

No comments found.

false

-

extString2

string

No comments found.

false

-

extString3

string

No comments found.

false

-

extString4

string

No comments found.

false

-

extString5

string

No comments found.

false

-

extString6

string

No comments found.

false

-

extString7

string

No comments found.

false

-

extString8

string

No comments found.

false

-

extString9

string

No comments found.

false

-

extString10

string

No comments found.

false

-

Request-example:

curl -X PUT -H 'Authorization' -i /api/org/org/updateRole --data 'id=292&remark=1vgsdb&createUserId=72&creator=18rqqk&createTime=2023-09-27 17:34:58&modifyUserId=548&modifyTime=2023-09-27 17:34:58&deleteFlag=0&ignoreWarning=true&nullFields=5i8pf6,5i8pf6&changeLogId=98&orgId=627&changeId=37&roleName=gil.paucek&roleCode=88129&roleEmployees=gys2ab&extString1=eox5ba&extString2=z5c78a&extString3=a890m0&extString4=bsa1rp&extString5=9l84gp&extString6=ptoc6d&extString7=k9x832&extString8=bkb5ly&extString9=jd05ya&extString10=pc1ey8'

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "2sjqsv",
      "defaultMsg": "oh4h10",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "t74048",
      "defaultMsg": "2wb0pk",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "gmq2ur",
      "defaultMsg": "c7g0dv",
      "context": {
        "object": "any object"
      }
    }
  ]
}

23.16.删除组织角色

Type: DELETE

Author: wangding

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

Description: 删除组织角色

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Path-parameters:

ParameterTypeDescriptionRequiredSince

key

int64

主键

true

-

Request-example:

curl -X DELETE -H 'Authorization' -i /api/org/org/deleteRole/364

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "gle0fp",
      "defaultMsg": "vv5phj",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "3gjfjk",
      "defaultMsg": "2z3ele",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "6vtqgb",
      "defaultMsg": "nfhecl",
      "context": {
        "object": "any object"
      }
    }
  ]
}

23.17.

Type: POST

Author: wangding

Content-Type: application/json

Description: 

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Body-parameters:

ParameterTypeDescriptionRequiredSince

id

int64

No comments found.

false

-

remark

string

No comments found.

false

-

createUserId

int64

No comments found.

false

-

creator

string

记录创建者

false

-

createTime

string

No comments found.

false

-

modifyUserId

int64

No comments found.

false

-

modifyTime

string

No comments found.

false

-

deleteFlag

int32

No comments found.

false

-

ignoreWarning

boolean

No comments found.

false

-

nullFields

array

No comments found.

false

-

changeLogId

int64

No comments found.

false

-

dimensionId

int64

No comments found.

false

-

parentId

int64

No comments found.

false

-

changeId

int64

No comments found.

false

-

orgName

string

No comments found.

false

-

orgCode

string

No comments found.

false

-

orgStatus

string

No comments found.

false

-

manageId

int64

No comments found.

false

-

isBu

int32

No comments found.

false

-

sortIndex

int32

No comments found.

false

-

extString1

string

No comments found.

false

-

extString2

string

No comments found.

false

-

extString3

string

No comments found.

false

-

extString4

string

No comments found.

false

-

extString5

string

No comments found.

false

-

extString6

string

No comments found.

false

-

extString7

string

No comments found.

false

-

extString8

string

No comments found.

false

-

extString9

string

No comments found.

false

-

extString10

string

No comments found.

false

-

initTenantId

int64

通过租户初始化数据 租户id

false

-

Request-example:

curl -X POST -H 'Content-Type: application/json' -H 'Authorization' -i /api/org/org/syncFromV4 --data '[
  {
    "id": 437,
    "remark": "r3d7kw",
    "createUserId": 865,
    "creator": "sq3oz2",
    "createTime": "2023-09-27 17:34:58",
    "modifyUserId": 67,
    "modifyTime": "2023-09-27 17:34:58",
    "deleteFlag": 0,
    "ignoreWarning": true,
    "nullFields": [
      "gpofjo"
    ],
    "changeLogId": 210,
    "dimensionId": 881,
    "parentId": 449,
    "changeId": 994,
    "orgName": "gil.paucek",
    "orgCode": "88129",
    "orgStatus": "m93r8j",
    "manageId": 344,
    "isBu": 349,
    "sortIndex": 1,
    "extString1": "qv01p0",
    "extString2": "qgt063",
    "extString3": "24psu5",
    "extString4": "keosqq",
    "extString5": "hx8uv6",
    "extString6": "wb4ng5",
    "extString7": "9a39ct",
    "extString8": "uvifhe",
    "extString9": "9gd51k",
    "extString10": "ijhgd3",
    "initTenantId": 491
  }
]'

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "m76l3r",
      "defaultMsg": "rd6yzb",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "fm1xxo",
      "defaultMsg": "84lif0",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "99afek",
      "defaultMsg": "5wnc60",
      "context": {
        "object": "any object"
      }
    }
  ]
}

24.公司管理

24.1.列表查询

Type: GET

Author: wangding

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

Description: 列表查询

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

relateType

string

相关主档(不传默认内部公司查询)

false

-

Request-example:

curl -X GET -H 'Authorization' -i /api/org/company/queryList?relateType=d8gjxd

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "ae9v0q",
      "defaultMsg": "xcna8o",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "hhzp20",
      "defaultMsg": "e1t6jg",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "qg4kra",
      "defaultMsg": "z5d6c5",
      "context": {
        "object": "any object"
      }
    }
  ]
}

25.维度版本管理

25.1.新建

Type: POST

Author: wangding

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

Description: 新建

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

id

int64

No comments found.

false

-

remark

string

No comments found.

false

-

createUserId

int64

No comments found.

false

-

creator

string

记录创建者

false

-

createTime

string

No comments found.

false

-

modifyUserId

int64

No comments found.

false

-

modifyTime

string

No comments found.

false

-

deleteFlag

int32

No comments found.

false

-

ignoreWarning

boolean

No comments found.

false

-

nullFields

array

No comments found.

false

-

changeLogId

int64

No comments found.

false

-

dimensionId

int64

No comments found.

false

-

versionNo

string

No comments found.

false

-

changeRecord

string

No comments found.

false

-

Request-example:

curl -X POST -H 'Authorization' -i /api/org/version/insert --data 'id=380&remark=hg6q5a&createUserId=647&creator=gs8cqg&createTime=2023-09-27 17:34:58&modifyUserId=1&modifyTime=2023-09-27 17:34:58&deleteFlag=0&ignoreWarning=true&nullFields=ll6z3r,ll6z3r&changeLogId=912&dimensionId=689&versionNo=btcmny&changeRecord=5vv0u9'

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "npgxun",
      "defaultMsg": "twqci6",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "o0m5zd",
      "defaultMsg": "cod127",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "q4e8yp",
      "defaultMsg": "5wemqo",
      "context": {
        "object": "any object"
      }
    }
  ]
}

25.2.全部修改

Type: PUT

Author: wangding

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

Description: 全部修改

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

id

int64

No comments found.

false

-

remark

string

No comments found.

false

-

createUserId

int64

No comments found.

false

-

creator

string

记录创建者

false

-

createTime

string

No comments found.

false

-

modifyUserId

int64

No comments found.

false

-

modifyTime

string

No comments found.

false

-

deleteFlag

int32

No comments found.

false

-

ignoreWarning

boolean

No comments found.

false

-

nullFields

array

No comments found.

false

-

changeLogId

int64

No comments found.

false

-

dimensionId

int64

No comments found.

false

-

versionNo

string

No comments found.

false

-

changeRecord

string

No comments found.

false

-

Request-example:

curl -X PUT -H 'Authorization' -i /api/org/version/update --data 'id=450&remark=anxlio&createUserId=234&creator=4e5bxk&createTime=2023-09-27 17:34:58&modifyUserId=23&modifyTime=2023-09-27 17:34:58&deleteFlag=0&ignoreWarning=true&nullFields=z1qa82,z1qa82&changeLogId=882&dimensionId=966&versionNo=z3onie&changeRecord=n5aj6y'

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "j495hz",
      "defaultMsg": "x4mhot",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "4nor9f",
      "defaultMsg": "4wqe7s",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "ewn8s2",
      "defaultMsg": "6ug7hp",
      "context": {
        "object": "any object"
      }
    }
  ]
}

25.3.逻辑删除

Type: DELETE

Author: wangding

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

Description: 逻辑删除

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Path-parameters:

ParameterTypeDescriptionRequiredSince

key

int64

主键

true

-

Request-example:

curl -X DELETE -H 'Authorization' -i /api/org/version/delete/521

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "3pentc",
      "defaultMsg": "lkjoyh",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "d1449p",
      "defaultMsg": "huss61",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "8ybnho",
      "defaultMsg": "pu96q1",
      "context": {
        "object": "any object"
      }
    }
  ]
}

25.4.根据维度id版本查询

Type: GET

Author: wangding

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

Description: 根据维度id版本查询

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

dimensionId

int64

主键

false

-

Request-example:

curl -X GET -H 'Authorization' -i /api/org/version/list?dimensionId=420

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "8ueg2u",
      "defaultMsg": "750qdv",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "gljvh8",
      "defaultMsg": "tcqe81",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "2j5qjo",
      "defaultMsg": "3hw9xg",
      "context": {
        "object": "any object"
      }
    }
  ]
}

26.维度管理

26.1.新建

Type: POST

Author: wangding

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

Description: 新建

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

id

int64

No comments found.

false

-

remark

string

No comments found.

false

-

createUserId

int64

No comments found.

false

-

creator

string

记录创建者

false

-

createTime

string

No comments found.

false

-

modifyUserId

int64

No comments found.

false

-

modifyTime

string

No comments found.

false

-

deleteFlag

int32

No comments found.

false

-

ignoreWarning

boolean

No comments found.

false

-

nullFields

array

No comments found.

false

-

changeLogId

int64

No comments found.

false

-

versionId

int64

No comments found.

false

-

dimensionName

string

No comments found.

false

-

dimensionCode

string

No comments found.

false

-

dimensionStatus

int32

No comments found.

false

-

defaultFlag

int32

0 默认 1非默认

false

-

extString1

string

No comments found.

false

-

extString2

string

No comments found.

false

-

extString3

string

No comments found.

false

-

extString4

string

No comments found.

false

-

extString5

string

No comments found.

false

-

extString6

string

No comments found.

false

-

extString7

string

No comments found.

false

-

extString8

string

No comments found.

false

-

extString9

string

No comments found.

false

-

extString10

string

No comments found.

false

-

initTenantId

int64

通过租户初始化数据 租户id

false

-

Request-example:

curl -X POST -H 'Authorization' -i /api/org/dimension/insert --data 'id=725&remark=pljb3o&createUserId=152&creator=m6jm8k&createTime=2023-09-27 17:34:58&modifyUserId=930&modifyTime=2023-09-27 17:34:58&deleteFlag=0&ignoreWarning=true&nullFields=wfsz6c,wfsz6c&changeLogId=978&versionId=297&dimensionName=gil.paucek&dimensionCode=88129&dimensionStatus=736&defaultFlag=0&extString1=4b3g2q&extString2=mxe411&extString3=0hy8eg&extString4=qhkphr&extString5=mq2694&extString6=fq4my8&extString7=v65ipu&extString8=8jy750&extString9=bc2uue&extString10=r6bzr0&initTenantId=532'

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "mdo46c",
      "defaultMsg": "q7qrs9",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "tky9i7",
      "defaultMsg": "b603ba",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "xf5fdu",
      "defaultMsg": "ohit1v",
      "context": {
        "object": "any object"
      }
    }
  ]
}

26.2.全部修改

Type: PUT

Author: wangding

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

Description: 全部修改

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

id

int64

No comments found.

false

-

remark

string

No comments found.

false

-

createUserId

int64

No comments found.

false

-

creator

string

记录创建者

false

-

createTime

string

No comments found.

false

-

modifyUserId

int64

No comments found.

false

-

modifyTime

string

No comments found.

false

-

deleteFlag

int32

No comments found.

false

-

ignoreWarning

boolean

No comments found.

false

-

nullFields

array

No comments found.

false

-

changeLogId

int64

No comments found.

false

-

versionId

int64

No comments found.

false

-

dimensionName

string

No comments found.

false

-

dimensionCode

string

No comments found.

false

-

dimensionStatus

int32

No comments found.

false

-

defaultFlag

int32

0 默认 1非默认

false

-

extString1

string

No comments found.

false

-

extString2

string

No comments found.

false

-

extString3

string

No comments found.

false

-

extString4

string

No comments found.

false

-

extString5

string

No comments found.

false

-

extString6

string

No comments found.

false

-

extString7

string

No comments found.

false

-

extString8

string

No comments found.

false

-

extString9

string

No comments found.

false

-

extString10

string

No comments found.

false

-

initTenantId

int64

通过租户初始化数据 租户id

false

-

Request-example:

curl -X PUT -H 'Authorization' -i /api/org/dimension/update --data 'id=996&remark=m0u6w8&createUserId=8&creator=1l9k8t&createTime=2023-09-27 17:34:58&modifyUserId=791&modifyTime=2023-09-27 17:34:58&deleteFlag=0&ignoreWarning=true&nullFields=uzmg4c,uzmg4c&changeLogId=255&versionId=588&dimensionName=gil.paucek&dimensionCode=88129&dimensionStatus=845&defaultFlag=0&extString1=crj02o&extString2=h973bj&extString3=b4yqw7&extString4=fspbld&extString5=ffd518&extString6=ijzksh&extString7=7fnbj1&extString8=c0jwr8&extString9=ov5bjc&extString10=2j87gv&initTenantId=873'

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "dug8tf",
      "defaultMsg": "0vovd3",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "khcwzz",
      "defaultMsg": "som7bj",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "yr3r6v",
      "defaultMsg": "5vbj0w",
      "context": {
        "object": "any object"
      }
    }
  ]
}

26.3.修改状态

Type: PUT

Author: wangding

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

Description: 修改状态

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

id

int64

主键

false

-

dimensionStatus

int32

维度状态

false

-

Request-example:

curl -X PUT -H 'Authorization' -i /api/org/dimension/updateStatus --data 'id=732&dimensionStatus=868'

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "sq91j6",
      "defaultMsg": "ticlec",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "7x4yog",
      "defaultMsg": "mioazo",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "702eqt",
      "defaultMsg": "dbaymi",
      "context": {
        "object": "any object"
      }
    }
  ]
}

26.4.逻辑删除

Type: DELETE

Author: wangding

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

Description: 逻辑删除

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

keys

array

主键,[array of int64]

false

-

Request-example:

curl -X DELETE -H 'Authorization' -i /api/org/dimension/delete?keys=bemxvq&keys=bemxvq

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "jk48uj",
      "defaultMsg": "9toa42",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "fq4ygs",
      "defaultMsg": "ywdfch",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "ewrbab",
      "defaultMsg": "1pgzdj",
      "context": {
        "object": "any object"
      }
    }
  ]
}

26.5.根据版本id查询

Type: GET

Author: wangding

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

Description: 根据版本id查询

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

versionId

int64

主键

false

-

Request-example:

curl -X GET -H 'Authorization' -i /api/org/dimension/queryByVersionId?versionId=602

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "qicth8",
      "defaultMsg": "mx6uzi",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "9x7glf",
      "defaultMsg": "3t4v4n",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "5dqevv",
      "defaultMsg": "k5qbhf",
      "context": {
        "object": "any object"
      }
    }
  ]
}

26.6.列表查询

Type: GET

Author: wangding

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

Description: 列表查询

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Request-example:

curl -X GET -H 'Authorization' -i /api/org/dimension/list

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "zgfbpq",
      "defaultMsg": "swbjez",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "yb7jz4",
      "defaultMsg": "ub6asu",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "1h5vu2",
      "defaultMsg": "rdfxc4",
      "context": {
        "object": "any object"
      }
    }
  ]
}

27.

27.1.新建

Type: POST

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

Description: 新建

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

id

int64

No comments found.

false

-

remark

string

No comments found.

false

-

createUserId

int64

No comments found.

false

-

creator

string

记录创建者

false

-

createTime

string

No comments found.

false

-

modifyUserId

int64

No comments found.

false

-

modifyTime

string

No comments found.

false

-

deleteFlag

int32

No comments found.

false

-

ignoreWarning

boolean

No comments found.

false

-

nullFields

array

No comments found.

false

-

changeLogId

int64

No comments found.

false

-

noticeTitle

string

公告标题

false

-

noticeAuthor

string

公告作者

false

-

noticeAuthorUserId

string

公告作者

false

-

sort

int32

排序

false

-

changeTime

string

更新时间

false

-

readAmount

int64

阅览量

false

-

topFlag

int32

置顶标志

false

-

noticeContent

string

公告内容

false

-

noticeAbstract

string

公告摘要

false

-

fileCodes

string

附件

false

-

publishFlag

int32

发布标志

false

-

noticeType

string

公告类型,正常类型：NORMAL,活动：ACTIVITY

false

-

sourceId

string

资源id 正常:为null，活动：活动id

false

-

triggerTimeExpression

string

定时发布（触发时间表达式）

false

-

Request-example:

curl -X POST -H 'Authorization' -i /api/org/company/notice/insert --data 'id=434&remark=4ttcor&createUserId=365&creator=b12ubs&createTime=2023-09-27 17:34:58&modifyUserId=504&modifyTime=2023-09-27 17:34:58&deleteFlag=0&ignoreWarning=true&nullFields=uyypi8,uyypi8&changeLogId=635¬iceTitle=n92ef7¬iceAuthor=Elva Spinka¬iceAuthorUserId=196&sort=832&changeTime=2023-09-27 17:34:58&readAmount=45&topFlag=0¬iceContent=ua81va¬iceAbstract=ouyvxk&fileCodes=iaqyhg&publishFlag=0¬iceType=8lumtn&sourceId=196&triggerTimeExpression=qu84cz'

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "xdccca",
      "defaultMsg": "nsyhmy",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "xdgoyy",
      "defaultMsg": "zk0hjy",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "uw93pt",
      "defaultMsg": "u06bek",
      "context": {
        "object": "any object"
      }
    }
  ]
}

27.2.全部修改

Type: PUT

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

Description: 全部修改

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

id

int64

No comments found.

false

-

remark

string

No comments found.

false

-

createUserId

int64

No comments found.

false

-

creator

string

记录创建者

false

-

createTime

string

No comments found.

false

-

modifyUserId

int64

No comments found.

false

-

modifyTime

string

No comments found.

false

-

deleteFlag

int32

No comments found.

false

-

ignoreWarning

boolean

No comments found.

false

-

nullFields

array

No comments found.

false

-

changeLogId

int64

No comments found.

false

-

noticeTitle

string

公告标题

false

-

noticeAuthor

string

公告作者

false

-

noticeAuthorUserId

string

公告作者

false

-

sort

int32

排序

false

-

changeTime

string

更新时间

false

-

readAmount

int64

阅览量

false

-

topFlag

int32

置顶标志

false

-

noticeContent

string

公告内容

false

-

noticeAbstract

string

公告摘要

false

-

fileCodes

string

附件

false

-

publishFlag

int32

发布标志

false

-

noticeType

string

公告类型,正常类型：NORMAL,活动：ACTIVITY

false

-

sourceId

string

资源id 正常:为null，活动：活动id

false

-

triggerTimeExpression

string

定时发布（触发时间表达式）

false

-

Request-example:

curl -X PUT -H 'Authorization' -i /api/org/company/notice/update --data 'id=441&remark=topl1a&createUserId=36&creator=q2bnln&createTime=2023-09-27 17:34:58&modifyUserId=311&modifyTime=2023-09-27 17:34:58&deleteFlag=0&ignoreWarning=true&nullFields=vpcxtk,vpcxtk&changeLogId=114¬iceTitle=sytau8¬iceAuthor=Elva Spinka¬iceAuthorUserId=196&sort=234&changeTime=2023-09-27 17:34:58&readAmount=46&topFlag=0¬iceContent=2v5u60¬iceAbstract=qk9vfm&fileCodes=mj1xjq&publishFlag=0¬iceType=niovy8&sourceId=196&triggerTimeExpression=7n0bpf'

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "8cmzod",
      "defaultMsg": "epzxou",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "x99iei",
      "defaultMsg": "izw7ub",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "zgr8fp",
      "defaultMsg": "0erct3",
      "context": {
        "object": "any object"
      }
    }
  ]
}

27.3.逻辑删除

Type: DELETE

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

Description: 逻辑删除

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

keys

array

主键,[array of int64]

false

-

Request-example:

curl -X DELETE -H 'Authorization' -i /api/org/company/notice/delete?keys=xopscm&keys=xopscm

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "ajff0m",
      "defaultMsg": "wiwxx1",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "t4j58y",
      "defaultMsg": "4f4l1q",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "4jgoy0",
      "defaultMsg": "6f9v8x",
      "context": {
        "object": "any object"
      }
    }
  ]
}

27.4.根据id查询

Type: GET

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

Description: 根据id查询

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Path-parameters:

ParameterTypeDescriptionRequiredSince

id

int64

主键

true

-

Request-example:

curl -X GET -H 'Authorization' -i /api/org/company/notice/426

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "rxpjvl",
      "defaultMsg": "wqm9hd",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "t36p0w",
      "defaultMsg": "ipo816",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "e5ueb4",
      "defaultMsg": "dz5hs6",
      "context": {
        "object": "any object"
      }
    }
  ]
}

27.5.分页条件查询

Type: GET

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

Description: 分页条件查询

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

current

int32

页码，默认为1

false

-

size

int32

页大小，默认为10

false

-

keyword

string

搜索关键字

false

-

idSet

object

ID

false

-

orders

array

排序

false

-

└─column

string

属性名称

false

-

└─asc

boolean

是否升序

false

-

id

int64

No comments found.

false

-

remark

string

No comments found.

false

-

createUserId

int64

No comments found.

false

-

loginUserId

int64

登录用户id 用于数据权限

false

-

createTimeStart

string

No comments found.

false

-

createTimeEnd

string

No comments found.

false

-

modifyUserId

int64

No comments found.

false

-

modifyTimeStart

string

No comments found.

false

-

modifyTimeEnd

string

No comments found.

false

-

dataPermissionFlag

boolean

No comments found.

false

-

noticeTitle

string

公告标题

false

-

noticeAuthorUserId

int64

公司作者

false

-

sort

int32

排序

false

-

changeTime

string

更新时间

false

-

readAmount

int64

阅览量

false

-

topFlag

int32

置顶标志

false

-

noticeContent

string

公司内容

false

-

noticeAbstract

string

公告摘要

false

-

noticeType

string

公告类型

false

-

fileCodes

string

附件

false

-

publishFlag

int32

发布标志

false

-

Request-example:

curl -X GET -H 'Authorization' -i /api/org/company/notice/pading?current=731&size=10&keyword=qx6iwl&column=c1l73v&asc=true&id=733&remark=c5h0ds&createUserId=959&loginUserId=504&createTimeStart=2023-09-27 17:34:58&createTimeEnd=2023-09-27 17:34:58&modifyUserId=586&modifyTimeStart=2023-09-27 17:34:58&modifyTimeEnd=2023-09-27 17:34:58&dataPermissionFlag=true¬iceTitle=utm5h4¬iceAuthorUserId=595&sort=301&changeTime=2023-09-27 17:34:58&readAmount=561&topFlag=0¬iceContent=3l6hci¬iceAbstract=rjmaex¬iceType=w45gjo&fileCodes=9incka&publishFlag=0&orders[0].column=5d7cmm&orders[0].asc=true

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "prebs6",
      "defaultMsg": "0gykay",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "rctzqa",
      "defaultMsg": "a6bfqd",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "caza0b",
      "defaultMsg": "ou6wuo",
      "context": {
        "object": "any object"
      }
    }
  ]
}

27.6.发布

Type: PUT

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

Description: 发布

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

keys

array

主键,[array of int64]

false

-

Request-example:

curl -X PUT -H 'Authorization' -i /api/org/company/notice/publish --data 'keys=s1u9j8&keys=s1u9j8'

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "yxhzq0",
      "defaultMsg": "rq4ra0",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "odi26c",
      "defaultMsg": "3w9uwj",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "43x9an",
      "defaultMsg": "s8voc6",
      "context": {
        "object": "any object"
      }
    }
  ]
}

27.7.撤销

Type: PUT

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

Description: 撤销

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

keys

array

主键,[array of int64]

false

-

Request-example:

curl -X PUT -H 'Authorization' -i /api/org/company/notice/revoke --data 'keys=2mu43j&keys=2mu43j'

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "e8tgzf",
      "defaultMsg": "hqnm83",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "82ne1v",
      "defaultMsg": "bzknbv",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "c7v1rn",
      "defaultMsg": "rdo691",
      "context": {
        "object": "any object"
      }
    }
  ]
}

27.8.列表查询

Type: GET

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

Description: 列表查询

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

current

int32

页码，默认为1

false

-

size

int32

页大小，默认为10

false

-

keyword

string

搜索关键字

false

-

idSet

object

ID

false

-

orders

array

排序

false

-

└─column

string

属性名称

false

-

└─asc

boolean

是否升序

false

-

id

int64

No comments found.

false

-

remark

string

No comments found.

false

-

createUserId

int64

No comments found.

false

-

loginUserId

int64

登录用户id 用于数据权限

false

-

createTimeStart

string

No comments found.

false

-

createTimeEnd

string

No comments found.

false

-

modifyUserId

int64

No comments found.

false

-

modifyTimeStart

string

No comments found.

false

-

modifyTimeEnd

string

No comments found.

false

-

dataPermissionFlag

boolean

No comments found.

false

-

noticeTitle

string

公告标题

false

-

noticeAuthorUserId

int64

公司作者

false

-

sort

int32

排序

false

-

changeTime

string

更新时间

false

-

readAmount

int64

阅览量

false

-

topFlag

int32

置顶标志

false

-

noticeContent

string

公司内容

false

-

noticeAbstract

string

公告摘要

false

-

noticeType

string

公告类型

false

-

fileCodes

string

附件

false

-

publishFlag

int32

发布标志

false

-

Request-example:

curl -X GET -H 'Authorization' -i /api/org/company/notice/queryList?current=643&size=10&keyword=py7x76&column=uyelsp&asc=true&id=720&remark=owcoo1&createUserId=845&loginUserId=654&createTimeStart=2023-09-27 17:34:58&createTimeEnd=2023-09-27 17:34:58&modifyUserId=339&modifyTimeStart=2023-09-27 17:34:58&modifyTimeEnd=2023-09-27 17:34:58&dataPermissionFlag=true¬iceTitle=nwcctq¬iceAuthorUserId=284&sort=261&changeTime=2023-09-27 17:34:58&readAmount=666&topFlag=0¬iceContent=uujlrt¬iceAbstract=vxoahy¬iceType=fu0fw0&fileCodes=gm13jy&publishFlag=0&orders[0].column=zam73g&orders[0].asc=true

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "po48ao",
      "defaultMsg": "uvsiiz",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "1365or",
      "defaultMsg": "sdej3g",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "wk0mn0",
      "defaultMsg": "4veu6y",
      "context": {
        "object": "any object"
      }
    }
  ]
}

28.员工管理

28.1.通过租户新增

Type: POST

Author: wangding

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

Description: 通过租户新增

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

id

int64

No comments found.

false

-

remark

string

No comments found.

false

-

createUserId

int64

No comments found.

false

-

creator

string

记录创建者

false

-

createTime

string

No comments found.

false

-

modifyUserId

int64

No comments found.

false

-

modifyTime

string

No comments found.

false

-

deleteFlag

int32

No comments found.

false

-

ignoreWarning

boolean

No comments found.

false

-

nullFields

array

No comments found.

false

-

changeLogId

int64

No comments found.

false

-

adminUserId

int64

租户管理员id

false

-

adminAccount

string

租户管理员账号

false

-

tenantId

string

租户id

false

-

tenantCode

string

租户编码

false

-

tenantName

string

租户名称

false

-

tenantType

string

租户类型

false

-

inited

boolean

是否初始化

false

-

enabled

boolean

是否启用

false

-

linkman

string

联系人

false

-

contactNumber

string

联系电话

false

-

address

string

联系地址

false

-

tenantIsolation

string

租户数据隔离

false

-

dbInitialized

boolean

数据库是否已初始化

false

-

databaseSourceId

int64

租户数据隔离数据源

false

-

schemaName

string

schema名称，如果租户数据隔离通过schema

false

-

tenantDomain

string

域名地址

false

-

customDomain

string

租户自定义域名

false

-

baseDataSyncId

int64

基础数据同步记录ID

false

-

industry

string

所属行业，[UDC]COM:INDUSTRY

false

-

customer

string

所属客户，[UDC]SYS:CUSTOMER

false

-

Request-example:

curl -X POST -H 'Authorization' -i /api/org/employee/saveTenantUser --data 'id=91&remark=fug237&createUserId=947&creator=zagsca&createTime=2023-09-27 17:34:58&modifyUserId=321&modifyTime=2023-09-27 17:34:58&deleteFlag=0&ignoreWarning=true&nullFields=8i8nym,8i8nym&changeLogId=547&adminUserId=444&adminAccount=snrmzo&tenantId=196&tenantCode=88129&tenantName=gil.paucek&tenantType=uca9mz&inited=true&enabled=true&linkman=m9rjbo&contactNumber=42qbd1&address=Apt. 994 784 Tom Junction， West Francine， MS 22939&tenantIsolation=wh4cly&dbInitialized=true&databaseSourceId=270&schemaName=gil.paucek&tenantDomain=beier.co&customDomain=beier.co&baseDataSyncId=553&industry=fcpshh&customer=nayfxl'

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "sbed9y",
      "defaultMsg": "0q9r95",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "cxn0fg",
      "defaultMsg": "rfbffu",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "21xlg6",
      "defaultMsg": "lcyqjl",
      "context": {
        "object": "any object"
      }
    }
  ]
}

28.2.新建

Type: POST

Author: wangding

Content-Type: application/json

Description: 新建

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Body-parameters:

ParameterTypeDescriptionRequiredSince

id

int64

No comments found.

false

-

remark

string

No comments found.

false

-

createUserId

int64

No comments found.

false

-

creator

string

记录创建者

false

-

createTime

string

No comments found.

false

-

modifyUserId

int64

No comments found.

false

-

modifyTime

string

No comments found.

false

-

deleteFlag

int32

No comments found.

false

-

ignoreWarning

boolean

No comments found.

false

-

nullFields

array

No comments found.

false

-

changeLogId

int64

No comments found.

false

-

userName

string

用户账号

false

-

lastName

string

用户姓氏

false

-

personName

string

用户真实姓名

false

-

mobile

string

用户电话

false

-

email

string

用户邮箱

false

-

enabled

boolean

账户状态

false

-

personId

int64

No comments found.

false

-

roleIds

array

角色IDs 如果修改的时候传值是 “null”表示赋值角色没有改变，如果是空数组“[]”表示把赋值角色全部删除

false

-

userId

int64

No comments found.

false

-

companyId

int64

公司ID

false

-

employeeNo

string

员工编号

false

-

employeeName

string

员工名称

false

-

resourceStatus

string

资源状态

false

-

hrStatus

string

人事状态

false

-

enrollDate

string

入职日期

false

-

accessLevel

int32

安全级别

false

-

jobs

string

岗位

false

-

sortIndex

int32

No comments found.

false

-

foreignName

string

外文名

false

-

idType

string

证件类型

false

-

idNo

string

证件号码

false

-

idValidFrom

string

证件开始日

false

-

idValidTo

string

证件到期日

false

-

idValidCodes

string

证件url

false

-

headCodes

string

头像url

false

-

birthday

string

生日

false

-

sex

string

性别

false

-

nationality

string

国籍

false

-

birthplace

string

籍贯

false

-

nation

string

民族

false

-

marital

int32

婚姻状况 0:已婚，1：未婚

false

-

addr

string

通讯地址

false

-

urgency_name

string

紧急联系人

false

-

urgency_mobile

string

紧急联系人手机号

false

-

urgency_ref

string

紧急联系人关系

false

-

parentNo

string

No comments found.

false

-

extString1

string

专业级别

false

-

extString2

string

管理级别

false

-

extString3

string

专业序列

false

-

extString4

string

职位序列

false

-

extString5

string

主服务地址

false

-

extString6

string

内部类型：内部资源，外部资源

false

-

extString7

string

话费额度

false

-

extString8

string

电脑额度

false

-

extString9

string

资源类型2 正式员工，实行生等

false

-

extString10

string

No comments found.

false

-

extString11

string

No comments found.

false

-

extString12

string

No comments found.

false

-

extDate1

string

离职日期

false

-

extDate2

string

转正日期

false

-

extDate3

string

合同签订日期

false

-

extDate4

string

合同到期日

false

-

extDate5

string

实习入职日期

false

-

extDate6

string

试用期开始

false

-

extDate7

string

试用期结束

false

-

extDate8

string

No comments found.

false

-

orgId

int64

组织id（新建员工初始默认组织使用）

false

-

parentId

int64

上级员工id（新建员工初始默认组织使用）

false

-

subType

string

修改类型

false

-

initTenantId

int64

通过租户初始化数据 租户id

false

-

Request-example:

curl -X POST -H 'Content-Type: application/json' -H 'Authorization' -i /api/org/employee/insert --data '{
  "id": 819,
  "remark": "e9ghmf",
  "createUserId": 887,
  "creator": "6zdkid",
  "createTime": "2023-09-27 17:34:58",
  "modifyUserId": 667,
  "modifyTime": "2023-09-27 17:34:58",
  "deleteFlag": 0,
  "ignoreWarning": true,
  "nullFields": [
    "3cltrt"
  ],
  "changeLogId": 562,
  "userName": "gil.paucek",
  "lastName": "gil.paucek",
  "personName": "gil.paucek",
  "mobile": "269.440.6235",
  "email": "maple.huel@hotmail.com",
  "enabled": true,
  "personId": 341,
  "roleIds": [
    550
  ],
  "userId": 277,
  "companyId": 895,
  "employeeNo": "gbzr71",
  "employeeName": "gil.paucek",
  "resourceStatus": "5vbtcn",
  "hrStatus": "ap0lqh",
  "enrollDate": "2023-09-27",
  "accessLevel": 217,
  "jobs": "6d2kjm",
  "sortIndex": 1,
  "foreignName": "gil.paucek",
  "idType": "n85kzn",
  "idNo": "tbywcy",
  "idValidFrom": "2023-09-27",
  "idValidTo": "2023-09-27",
  "idValidCodes": "pgdm50",
  "headCodes": "emgfo0",
  "birthday": "2023-09-27",
  "sex": "kx0wkn",
  "nationality": "yxy9oo",
  "birthplace": "qq8yig",
  "nation": "b67f4b",
  "marital": 724,
  "addr": "olrh2g",
  "urgency_name": "gil.paucek",
  "urgency_mobile": "269.440.6235",
  "urgency_ref": "c9l1mb",
  "parentNo": "n4gisn",
  "extString1": "0nbroo",
  "extString2": "kke7aq",
  "extString3": "sws6jy",
  "extString4": "z6vqam",
  "extString5": "ipuodu",
  "extString6": "y3j1w0",
  "extString7": "zmbizl",
  "extString8": "w876kl",
  "extString9": "bhk0vu",
  "extString10": "4ehgi6",
  "extString11": "6vura7",
  "extString12": "f1y4dh",
  "extDate1": "2023-09-27",
  "extDate2": "2023-09-27",
  "extDate3": "2023-09-27",
  "extDate4": "2023-09-27",
  "extDate5": "2023-09-27",
  "extDate6": "2023-09-27",
  "extDate7": "2023-09-27",
  "extDate8": "2023-09-27",
  "orgId": 506,
  "parentId": 466,
  "subType": "6ru49f",
  "initTenantId": 459
}'

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "ga0dmr",
      "defaultMsg": "26ujyd",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "oogpel",
      "defaultMsg": "p1weze",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "mp6bjl",
      "defaultMsg": "kt5g9y",
      "context": {
        "object": "any object"
      }
    }
  ]
}

28.3.全部修改

Type: PUT

Author: wangding

Content-Type: application/json

Description: 全部修改

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Body-parameters:

ParameterTypeDescriptionRequiredSince

id

int64

No comments found.

false

-

remark

string

No comments found.

false

-

createUserId

int64

No comments found.

false

-

creator

string

记录创建者

false

-

createTime

string

No comments found.

false

-

modifyUserId

int64

No comments found.

false

-

modifyTime

string

No comments found.

false

-

deleteFlag

int32

No comments found.

false

-

ignoreWarning

boolean

No comments found.

false

-

nullFields

array

No comments found.

false

-

changeLogId

int64

No comments found.

false

-

userName

string

用户账号

false

-

lastName

string

用户姓氏

false

-

personName

string

用户真实姓名

false

-

mobile

string

用户电话

false

-

email

string

用户邮箱

false

-

enabled

boolean

账户状态

false

-

personId

int64

No comments found.

false

-

roleIds

array

角色IDs 如果修改的时候传值是 “null”表示赋值角色没有改变，如果是空数组“[]”表示把赋值角色全部删除

false

-

userId

int64

No comments found.

false

-

companyId

int64

公司ID

false

-

employeeNo

string

员工编号

false

-

employeeName

string

员工名称

false

-

resourceStatus

string

资源状态

false

-

hrStatus

string

人事状态

false

-

enrollDate

string

入职日期

false

-

accessLevel

int32

安全级别

false

-

jobs

string

岗位

false

-

sortIndex

int32

No comments found.

false

-

foreignName

string

外文名

false

-

idType

string

证件类型

false

-

idNo

string

证件号码

false

-

idValidFrom

string

证件开始日

false

-

idValidTo

string

证件到期日

false

-

idValidCodes

string

证件url

false

-

headCodes

string

头像url

false

-

birthday

string

生日

false

-

sex

string

性别

false

-

nationality

string

国籍

false

-

birthplace

string

籍贯

false

-

nation

string

民族

false

-

marital

int32

婚姻状况 0:已婚，1：未婚

false

-

addr

string

通讯地址

false

-

urgency_name

string

紧急联系人

false

-

urgency_mobile

string

紧急联系人手机号

false

-

urgency_ref

string

紧急联系人关系

false

-

parentNo

string

No comments found.

false

-

extString1

string

专业级别

false

-

extString2

string

管理级别

false

-

extString3

string

专业序列

false

-

extString4

string

职位序列

false

-

extString5

string

主服务地址

false

-

extString6

string

内部类型：内部资源，外部资源

false

-

extString7

string

话费额度

false

-

extString8

string

电脑额度

false

-

extString9

string

资源类型2 正式员工，实行生等

false

-

extString10

string

No comments found.

false

-

extString11

string

No comments found.

false

-

extString12

string

No comments found.

false

-

extDate1

string

离职日期

false

-

extDate2

string

转正日期

false

-

extDate3

string

合同签订日期

false

-

extDate4

string

合同到期日

false

-

extDate5

string

实习入职日期

false

-

extDate6

string

试用期开始

false

-

extDate7

string

试用期结束

false

-

extDate8

string

No comments found.

false

-

orgId

int64

组织id（新建员工初始默认组织使用）

false

-

parentId

int64

上级员工id（新建员工初始默认组织使用）

false

-

subType

string

修改类型

false

-

initTenantId

int64

通过租户初始化数据 租户id

false

-

Request-example:

curl -X PUT -H 'Content-Type: application/json' -H 'Authorization' -i /api/org/employee/update --data '{
  "id": 801,
  "remark": "0egwr1",
  "createUserId": 678,
  "creator": "marc3b",
  "createTime": "2023-09-27 17:34:58",
  "modifyUserId": 496,
  "modifyTime": "2023-09-27 17:34:58",
  "deleteFlag": 0,
  "ignoreWarning": true,
  "nullFields": [
    "qbo18d"
  ],
  "changeLogId": 627,
  "userName": "gil.paucek",
  "lastName": "gil.paucek",
  "personName": "gil.paucek",
  "mobile": "269.440.6235",
  "email": "maple.huel@hotmail.com",
  "enabled": true,
  "personId": 950,
  "roleIds": [
    447
  ],
  "userId": 219,
  "companyId": 692,
  "employeeNo": "bki23y",
  "employeeName": "gil.paucek",
  "resourceStatus": "o9wlex",
  "hrStatus": "cviw58",
  "enrollDate": "2023-09-27",
  "accessLevel": 683,
  "jobs": "2qwq70",
  "sortIndex": 1,
  "foreignName": "gil.paucek",
  "idType": "uvjodb",
  "idNo": "uuk5bc",
  "idValidFrom": "2023-09-27",
  "idValidTo": "2023-09-27",
  "idValidCodes": "zmctw9",
  "headCodes": "154rj1",
  "birthday": "2023-09-27",
  "sex": "5pzxpr",
  "nationality": "vyh1lj",
  "birthplace": "8cgp2r",
  "nation": "sutfea",
  "marital": 765,
  "addr": "ths698",
  "urgency_name": "gil.paucek",
  "urgency_mobile": "269.440.6235",
  "urgency_ref": "s9fiv5",
  "parentNo": "68oxc1",
  "extString1": "zat7c2",
  "extString2": "hi1r1n",
  "extString3": "2lqjpp",
  "extString4": "9ipiun",
  "extString5": "8zkqix",
  "extString6": "3l6nt4",
  "extString7": "4cnoxq",
  "extString8": "7faxgy",
  "extString9": "wue75i",
  "extString10": "oe0744",
  "extString11": "rj8ci4",
  "extString12": "8i9cdx",
  "extDate1": "2023-09-27",
  "extDate2": "2023-09-27",
  "extDate3": "2023-09-27",
  "extDate4": "2023-09-27",
  "extDate5": "2023-09-27",
  "extDate6": "2023-09-27",
  "extDate7": "2023-09-27",
  "extDate8": "2023-09-27",
  "orgId": 812,
  "parentId": 442,
  "subType": "mh942u",
  "initTenantId": 891
}'

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "0w0nev",
      "defaultMsg": "of5a7k",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "phqd02",
      "defaultMsg": "iixans",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "8hppfx",
      "defaultMsg": "7gcv0o",
      "context": {
        "object": "any object"
      }
    }
  ]
}

28.4.修改员工组织关系

Type: PUT

Author: wangding

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

Description: 修改员工组织关系

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

payloadStrs

string

po类

false

-

Request-example:

curl -X PUT -H 'Authorization' -i /api/org/employee/updateEmployeeRef --data 'payloadStrs=ulzrcp'

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "6p08of",
      "defaultMsg": "rdoihs",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "fm0m7f",
      "defaultMsg": "tz82gz",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "xubc6p",
      "defaultMsg": "pouqmp",
      "context": {
        "object": "any object"
      }
    }
  ]
}

28.5.人员选择器

Type: GET

Author: wangding

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

Description: 人员选择器

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

current

int32

页码，默认为1

false

-

size

int32

页大小，默认为10

false

-

keyword

string

搜索关键字

false

-

idSet

object

ID

false

-

orders

array

排序

false

-

└─column

string

属性名称

false

-

└─asc

boolean

是否升序

false

-

id

int64

No comments found.

false

-

remark

string

No comments found.

false

-

createUserId

int64

No comments found.

false

-

loginUserId

int64

登录用户id 用于数据权限

false

-

createTimeStart

string

No comments found.

false

-

createTimeEnd

string

No comments found.

false

-

modifyUserId

int64

No comments found.

false

-

modifyTimeStart

string

No comments found.

false

-

modifyTimeEnd

string

No comments found.

false

-

dataPermissionFlag

boolean

No comments found.

false

-

employeeIds

array

员工id列表

false

-

employeeNo

string

员工编号

false

-

personName

string

员工名称

false

-

enabled

boolean

账户状态

false

-

orgId

int64

组织Id

false

-

resourceStatus

string

资源状态

false

-

hrStatus

string

人事状态

false

-

enrollDate

string

入职日期

false

-

accessLevel

int32

安全级别

false

-

jobs

string

岗位

false

-

companyId

int64

公司

false

-

extString1

string

专业级别

false

-

extString2

string

管理级别

false

-

extString3

string

专业序列

false

-

extString4

string

职位序列

false

-

extString5

string

主服务地址

false

-

extString6

string

内部类型

false

-

extString7

string

话费额度

false

-

extString8

string

电脑额度

false

-

extString9

string

No comments found.

false

-

extString10

string

No comments found.

false

-

extString11

string

No comments found.

false

-

extString12

string

No comments found.

false

-

extDate1

string

离职日期

false

-

extDate2

string

转正日期

false

-

extDate3

string

合同签订日期

false

-

extDate4

string

合同到期日

false

-

extDate5

string

实习入职日期

false

-

extDate6

string

试用期开始

false

-

extDate7

string

试用期结束

false

-

extDate8

string

No comments found.

false

-

downloadType

string

导出类型 model:模板，data:数据

false

-

roleIds

array

系统角色ids

false

-

userIds

array

用户id

false

-

isPermission

boolean

是否需要权限判断

false

-

userIdList

array

用户id

false

-

Request-example:

curl -X GET -H 'Authorization' -i /api/org/employee/list?current=18&size=10&keyword=vew50y&column=hi1bd3&asc=true&id=349&remark=zo2ipn&createUserId=614&loginUserId=76&createTimeStart=2023-09-27 17:34:58&createTimeEnd=2023-09-27 17:34:58&modifyUserId=949&modifyTimeStart=2023-09-27 17:34:58&modifyTimeEnd=2023-09-27 17:34:58&dataPermissionFlag=true&employeeIds=422,422&employeeNo=ycanjs&personName=gil.paucek&enabled=true&orgId=319&resourceStatus=ys41es&hrStatus=hosq81&enrollDate=2023-09-27&accessLevel=913&jobs=ben27i&companyId=38&extString1=jrs7z1&extString2=bzv9oi&extString3=g77ub5&extString4=oy7i6a&extString5=n94yha&extString6=5olnuo&extString7=gozt8c&extString8=ujhert&extString9=25x9mk&extString10=k6z62m&extString11=5akszr&extString12=ohalbs&extDate1=2023-09-27&extDate2=2023-09-27&extDate3=2023-09-27&extDate4=2023-09-27&extDate5=2023-09-27&extDate6=2023-09-27&extDate7=2023-09-27&extDate8=2023-09-27&downloadType=zgx80d&roleIds=208,208&userIds=533,533&isPermission=true&userIdList=515,515&orders[0].asc=true&orders[0].column=o3kjrx

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "mhg92k",
      "defaultMsg": "1nj7bd",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "h2s7w6",
      "defaultMsg": "cixkop",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "e1cew2",
      "defaultMsg": "m633g3",
      "context": {
        "object": "any object"
      }
    }
  ]
}

28.6.分页条件查询

Type: GET

Author: wangding

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

Description: 分页条件查询

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

current

int32

页码，默认为1

false

-

size

int32

页大小，默认为10

false

-

keyword

string

搜索关键字

false

-

idSet

object

ID

false

-

orders

array

排序

false

-

└─column

string

属性名称

false

-

└─asc

boolean

是否升序

false

-

id

int64

No comments found.

false

-

remark

string

No comments found.

false

-

createUserId

int64

No comments found.

false

-

loginUserId

int64

登录用户id 用于数据权限

false

-

createTimeStart

string

No comments found.

false

-

createTimeEnd

string

No comments found.

false

-

modifyUserId

int64

No comments found.

false

-

modifyTimeStart

string

No comments found.

false

-

modifyTimeEnd

string

No comments found.

false

-

dataPermissionFlag

boolean

No comments found.

false

-

employeeIds

array

员工id列表

false

-

employeeNo

string

员工编号

false

-

personName

string

员工名称

false

-

enabled

boolean

账户状态

false

-

orgId

int64

组织Id

false

-

resourceStatus

string

资源状态

false

-

hrStatus

string

人事状态

false

-

enrollDate

string

入职日期

false

-

accessLevel

int32

安全级别

false

-

jobs

string

岗位

false

-

companyId

int64

公司

false

-

extString1

string

专业级别

false

-

extString2

string

管理级别

false

-

extString3

string

专业序列

false

-

extString4

string

职位序列

false

-

extString5

string

主服务地址

false

-

extString6

string

内部类型

false

-

extString7

string

话费额度

false

-

extString8

string

电脑额度

false

-

extString9

string

No comments found.

false

-

extString10

string

No comments found.

false

-

extString11

string

No comments found.

false

-

extString12

string

No comments found.

false

-

extDate1

string

离职日期

false

-

extDate2

string

转正日期

false

-

extDate3

string

合同签订日期

false

-

extDate4

string

合同到期日

false

-

extDate5

string

实习入职日期

false

-

extDate6

string

试用期开始

false

-

extDate7

string

试用期结束

false

-

extDate8

string

No comments found.

false

-

downloadType

string

导出类型 model:模板，data:数据

false

-

roleIds

array

系统角色ids

false

-

userIds

array

用户id

false

-

isPermission

boolean

是否需要权限判断

false

-

userIdList

array

用户id

false

-

Request-example:

curl -X GET -H 'Authorization' -i /api/org/employee/pading?current=714&size=10&keyword=bfxe0a&column=tbgraq&asc=true&id=922&remark=qc3sqt&createUserId=160&loginUserId=271&createTimeStart=2023-09-27 17:34:58&createTimeEnd=2023-09-27 17:34:58&modifyUserId=317&modifyTimeStart=2023-09-27 17:34:58&modifyTimeEnd=2023-09-27 17:34:58&dataPermissionFlag=true&employeeIds=461,461&employeeNo=zmer3j&personName=gil.paucek&enabled=true&orgId=759&resourceStatus=hon5z3&hrStatus=z6siia&enrollDate=2023-09-27&accessLevel=587&jobs=uggj8e&companyId=373&extString1=0j78k7&extString2=lxw9wi&extString3=x8cijq&extString4=efub4n&extString5=7wihcw&extString6=m42exf&extString7=s2bd55&extString8=soyg9x&extString9=9c3quu&extString10=0ogeec&extString11=li52o5&extString12=ha8d17&extDate1=2023-09-27&extDate2=2023-09-27&extDate3=2023-09-27&extDate4=2023-09-27&extDate5=2023-09-27&extDate6=2023-09-27&extDate7=2023-09-27&extDate8=2023-09-27&downloadType=2i9l0h&roleIds=712,712&userIds=29,29&isPermission=true&userIdList=438,438&orders[0].asc=true&orders[0].column=4up963

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "hgec2d",
      "defaultMsg": "tb8k5p",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "65httw",
      "defaultMsg": "g8fubw",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "u1rjqs",
      "defaultMsg": "fdxerr",
      "context": {
        "object": "any object"
      }
    }
  ]
}

28.7.根据主键查询

Type: GET

Author: wangding

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

Description: 根据主键查询

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Path-parameters:

ParameterTypeDescriptionRequiredSince

key

int64

主键

true

-

Request-example:

curl -X GET -H 'Authorization' -i /api/org/employee/873

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "ai6u4r",
      "defaultMsg": "gapphu",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "s1a1v0",
      "defaultMsg": "xf0e2c",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "o9ivxn",
      "defaultMsg": "dli3ai",
      "context": {
        "object": "any object"
      }
    }
  ]
}

28.8.根据主键查询所有上级id

Type: GET

Author: wangding

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

Description: 根据主键查询所有上级id

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Path-parameters:

ParameterTypeDescriptionRequiredSince

key

int64

主键

true

-

Request-example:

curl -X GET -H 'Authorization' -i /api/org/employee/queryParentIds/601

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "d4gwyg",
      "defaultMsg": "sta04a",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "fpabu1",
      "defaultMsg": "vkwo8a",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "w8k9fg",
      "defaultMsg": "5qgtw5",
      "context": {
        "object": "any object"
      }
    }
  ]
}

28.9.逻辑删除

Type: DELETE

Author: wangding

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

Description: 逻辑删除

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

keys

array

主键,[array of int64]

false

-

Request-example:

curl -X DELETE -H 'Authorization' -i /api/org/employee/delete?keys=ekfpp5&keys=ekfpp5

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "kbz7b3",
      "defaultMsg": "q20o2m",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "bqh0pq",
      "defaultMsg": "pwrlok",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "l2p4fk",
      "defaultMsg": "63f25r",
      "context": {
        "object": "any object"
      }
    }
  ]
}

28.10.移除员工组织

Type: PUT

Author: wangding

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

Description: 移除员工组织

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

userId

int64

员工id

false

-

orgIds

array

组织ids,[array of int64]

false

-

Request-example:

curl -X PUT -H 'Authorization' -i /api/org/employee/deleteOrg --data 'userId=60&orgIds=mcn5b4&orgIds=mcn5b4'

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "9suei8",
      "defaultMsg": "uy3r19",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "flyh4l",
      "defaultMsg": "6dwr20",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "7lvagx",
      "defaultMsg": "ny2zto",
      "context": {
        "object": "any object"
      }
    }
  ]
}

28.11.重置密码

Type: GET

Author: wangding

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

Description: 重置密码

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Path-parameters:

ParameterTypeDescriptionRequiredSince

userId

int64

被操作员工主键

true

-

Request-example:

curl -X GET -H 'Authorization' -i /api/org/employee/resetEmployeePawword/194

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "mld02k",
      "defaultMsg": "pxoy8h",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "2ac5kc",
      "defaultMsg": "czubg3",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "jz5qmo",
      "defaultMsg": "0bh5g4",
      "context": {
        "object": "any object"
      }
    }
  ]
}

28.12.更新企业微信id

Type: GET

Author: wangding

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

Description: 更新企业微信id

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

userId

array

No comments found.,[array of int64]

false

-

Request-example:

curl -X GET -H 'Authorization' -i /api/org/employee/updateWecomId?userId=9rw97v&userId=9rw97v

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "51d8mi",
      "defaultMsg": "gxauo8",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "nes6jl",
      "defaultMsg": "1uhwx1",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "q6eklg",
      "defaultMsg": "blryzh",
      "context": {
        "object": "any object"
      }
    }
  ]
}

28.13.批量导出excel

Type: GET

Author: wangding

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

Description: 批量导出excel

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

current

int32

页码，默认为1

false

-

size

int32

页大小，默认为10

false

-

keyword

string

搜索关键字

false

-

idSet

object

ID

false

-

orders

array

排序

false

-

└─column

string

属性名称

false

-

└─asc

boolean

是否升序

false

-

id

int64

No comments found.

false

-

remark

string

No comments found.

false

-

createUserId

int64

No comments found.

false

-

loginUserId

int64

登录用户id 用于数据权限

false

-

createTimeStart

string

No comments found.

false

-

createTimeEnd

string

No comments found.

false

-

modifyUserId

int64

No comments found.

false

-

modifyTimeStart

string

No comments found.

false

-

modifyTimeEnd

string

No comments found.

false

-

dataPermissionFlag

boolean

No comments found.

false

-

employeeIds

array

员工id列表

false

-

employeeNo

string

员工编号

false

-

personName

string

员工名称

false

-

enabled

boolean

账户状态

false

-

orgId

int64

组织Id

false

-

resourceStatus

string

资源状态

false

-

hrStatus

string

人事状态

false

-

enrollDate

string

入职日期

false

-

accessLevel

int32

安全级别

false

-

jobs

string

岗位

false

-

companyId

int64

公司

false

-

extString1

string

专业级别

false

-

extString2

string

管理级别

false

-

extString3

string

专业序列

false

-

extString4

string

职位序列

false

-

extString5

string

主服务地址

false

-

extString6

string

内部类型

false

-

extString7

string

话费额度

false

-

extString8

string

电脑额度

false

-

extString9

string

No comments found.

false

-

extString10

string

No comments found.

false

-

extString11

string

No comments found.

false

-

extString12

string

No comments found.

false

-

extDate1

string

离职日期

false

-

extDate2

string

转正日期

false

-

extDate3

string

合同签订日期

false

-

extDate4

string

合同到期日

false

-

extDate5

string

实习入职日期

false

-

extDate6

string

试用期开始

false

-

extDate7

string

试用期结束

false

-

extDate8

string

No comments found.

false

-

downloadType

string

导出类型 model:模板，data:数据

false

-

roleIds

array

系统角色ids

false

-

userIds

array

用户id

false

-

isPermission

boolean

是否需要权限判断

false

-

userIdList

array

用户id

false

-

Request-example:

curl -X GET -H 'Authorization' -i /api/org/employee/batchExport?current=102&size=10&keyword=acr8s2&column=nxpvtj&asc=true&id=125&remark=8twk06&createUserId=424&loginUserId=289&createTimeStart=2023-09-27 17:34:58&createTimeEnd=2023-09-27 17:34:58&modifyUserId=670&modifyTimeStart=2023-09-27 17:34:58&modifyTimeEnd=2023-09-27 17:34:58&dataPermissionFlag=true&employeeIds=559,559&employeeNo=6kxf20&personName=gil.paucek&enabled=true&orgId=372&resourceStatus=vudihj&hrStatus=ljnsgh&enrollDate=2023-09-27&accessLevel=509&jobs=7ydcs4&companyId=317&extString1=3zkljr&extString2=gqc4ox&extString3=19sku3&extString4=k09onw&extString5=snnq79&extString6=7egjdj&extString7=5v7rfn&extString8=gr5g40&extString9=w5o08v&extString10=wtt9z9&extString11=1bhglz&extString12=5awgih&extDate1=2023-09-27&extDate2=2023-09-27&extDate3=2023-09-27&extDate4=2023-09-27&extDate5=2023-09-27&extDate6=2023-09-27&extDate7=2023-09-27&extDate8=2023-09-27&downloadType=jhovjq&roleIds=914,914&userIds=638,638&isPermission=true&userIdList=227,227&orders[0].asc=true&orders[0].column=p0fd4m

Response-example:

Return void.

28.14.批量导入excel

Type: POST

Author: wangding

Content-Type: multipart/form-data

Description: 批量导入excel

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

file

file

No comments found.

false

-

Request-example:

curl -X POST -H 'Content-Type: multipart/form-data' -H 'Authorization' -F 'file=' -i /api/org/employee/batchImport

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "81gfji",
      "defaultMsg": "g1at4n",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "xpsrq8",
      "defaultMsg": "kjzl68",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "hdyuz9",
      "defaultMsg": "qvxn4c",
      "context": {
        "object": "any object"
      }
    }
  ]
}

29.启信宝-第三方服务接口

29.1.1.31 模糊搜索

Type: GET

Author: duwh

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

Description: 1.31 模糊搜索

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

matchType

string

匹配类型（可选），keyword 需要匹配的 字段，可以输入以下一个或者几个类型， 多个类型使用

false

-

region

string

地区编码（可选），输入参数为空返回全 部区域匹配记录。可传入 省/直辖市，城市，区县的国家区划码。 只支持传入一个区划码。 省/直辖市：传入国家区划码前两位数字， 如搜索“江苏省”则传入 32，各省/直辖 市编码可参考本文档附录 城市：传入国家区划码前四位数字，如搜 索“苏州市”，则传入 3205 区县：传入国家区划码六位数字，如搜索 “苏州市吴中区”，则传入 320506 可以通过下面网页查询国家区划编码 http://www.mca.gov.cn/article/sj/tj bz/a/2017/2018

false

-

keyword

string

关键字（必填） 企业全名/注册号/统一社会信用代码

false

-

skip

string

跳过(可选) 跳过条目数（默认为0，单页返回10条数据）

false

-

Request-example:

curl -X GET -H 'Authorization' -i /api/qixin/search?matchType=分隔： partner：股东 oper：法人 4 member：高管 contact：联系方式 scope：经营范围 name：公司名称 patent：专利 copyright：著作权作品名称 software：软件著作权名称 trademark：商标 domain：网址 product：产品®ion=mswp27&keyword=r9fw7z&skip=233.15.56.44

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "2b2x1k",
      "defaultMsg": "666491",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "fsa29l",
      "defaultMsg": "lrc4kg",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "d4ijuy",
      "defaultMsg": "zve51a",
      "context": {
        "object": "any object"
      }
    }
  ]
}

29.2.1.2 高级搜索

Type: GET

Author: duwh

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

Description: 1.2 高级搜索

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

keyword

string

企业全名/注册号/统一社会信用代码

false

-

skip

string

跳过条目数（默认为0，单页返回20条数据）

false

-

method

string

搜索范围，多个使用逗号分隔，具体值参 考附录

false

-

org_type

string

组织类型，多个使用逗号分隔，具体值参 考附录

false

-

area_code

string

地区码

false

-

industry_code

string

行业码

false

-

econ_type

string

企业类型，多个使用逗号分隔，具体值参 考附录

false

-

capi_from

string

注册资本起

false

-

capi_to

string

注册资本止

false

-

date_from

string

成立日期起

false

-

date_to

string

成立日期止

false

-

status

string

企业状态，多个使用逗号分隔，具体值参 考附录

false

-

canbao_from

string

参保人数起

false

-

canbao_to

string

参保人数止

false

-

Request-example:

curl -X GET -H 'Authorization' -i /api/qixin/advanceSearchNew?keyword=gtt4lm&skip=233.15.56.44&method=wtmxja&org_type=7ghjjw&area_code=88129&industry_code=88129&econ_type=gn201n&capi_from=clpm7q&capi_to=43vk8j&date_from=hvbeyj&date_to=qlqxw2&status=ti7v4q&canbao_from=ui9nmm&canbao_to=61mw9e

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "33xmhj",
      "defaultMsg": "y71sx9",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "0n3ogp",
      "defaultMsg": "jqgdtq",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "2c6tva",
      "defaultMsg": "et376r",
      "context": {
        "object": "any object"
      }
    }
  ]
}

29.3.获取企业联系方式 1.51 企业联系方式

Type: GET

Author: duwh

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

Description: 获取企业联系方式 1.51 企业联系方式

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

keyword

string

关键字 企业全名/注册号/统一社会信用代码

false

-

Request-example:

curl -X GET -H 'Authorization' -i /api/qixin/getContactInfo?keyword=zx7gzq

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "ekldnm",
      "defaultMsg": "ua0aje",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "pccqf1",
      "defaultMsg": "9ultjl",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "zy3kyr",
      "defaultMsg": "zhk2xo",
      "context": {
        "object": "any object"
      }
    }
  ]
}

29.4.10.1 新闻列表
缓存1天（key = name+create_time_range+skip）
企业新闻列表，包括新闻来源、情感属性、舆情标签、负面指数等
申请接口
单价：0.1元/次

Type: GET

Author: duwh

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

Description: 10.1 新闻列表
缓存1天（key = name+create_time_range+skip）
企业新闻列表，包括新闻来源、情感属性、舆情标签、负面指数等
申请接口
单价：0.1元/次

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

name

string

必填 企业全名/注册号/统一社会信用代码

false

-

skip

string

跳过条目数（默认为 0）

false

-

tag_list

string

舆情分类，参考数据字典tag_list字段，示例：["131","132"]

false

-

sentiment

string

情感属性，参考数据字典sentiment字段，示例：["neg","pos"]

false

-

company_sentiment

string

企业的情感属性，参考数据字典sentiment字段，示例：["neg","pos"]

false

-

class_types

string

新闻类别，全部可不传，参考数据字典class_types字段，示例：["news"]

false

-

new_tag_list

string

事件分类，参考数据字典new_tag_list字段，示例：["101","1024"]

false

-

company_new_tag

string

企业的事件分类，参考数据字典new_tag_list字段，示例：["0102004","0102005"]

false

-

create_time_range

string

舆情发布时间范围，示例：["2019-01-01","2019-08-14"]

false

-

Request-example:

curl -X GET -H 'Authorization' -i /api/qixin/getNewsListByName?name=gil.paucek&skip=233.15.56.44&tag_list=env8n8&sentiment=zx6486&company_sentiment=2xqq5y&class_types=1jer51&new_tag_list=np3a2k&company_new_tag=2wqzkz&create_time_range=furj4s

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "d2dlv5",
      "defaultMsg": "72mgfk",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "fbgbz7",
      "defaultMsg": "g6zzbt",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "jfv6a5",
      "defaultMsg": "xpr4nb",
      "context": {
        "object": "any object"
      }
    }
  ]
}

29.5.1.41 工商照面
企业工商照面及相关信息，包括统一社会信用代码、注册资本、经营范围、企业法定代表人等

Type: GET

Author: duwh

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

Description: 1.41 工商照面
企业工商照面及相关信息，包括统一社会信用代码、注册资本、经营范围、企业法定代表人等

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

keyword

string

企业全名/注册号/统一社会信用代码

false

-

Request-example:

curl -X GET -H 'Authorization' -i /api/qixin/getBasicInfo?keyword=ued793

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "82fbs9",
      "defaultMsg": "49vhtv",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "0shjh9",
      "defaultMsg": "46s9rc",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "2eut2j",
      "defaultMsg": "7jfved",
      "context": {
        "object": "any object"
      }
    }
  ]
}

Type: GET

Author: duwh

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

Description: 1.17 企业LOGO

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

name

string

企业全名

false

-

Request-example:

curl -X GET -H 'Authorization' -i /api/qixin/getEntLogoByName?name=gil.paucek

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "66o45b",
      "defaultMsg": "sczedf",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "nuahyk",
      "defaultMsg": "d0zkcz",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "oi8ahb",
      "defaultMsg": "75vw9t",
      "context": {
        "object": "any object"
      }
    }
  ]
}

29.7.1.16 企业简介

Type: GET

Author: duwh

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

Description: 1.16 企业简介

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

name

string

企业全名

false

-

Request-example:

curl -X GET -H 'Authorization' -i /api/qixin/getEntBriefByName?name=gil.paucek

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "rwdfym",
      "defaultMsg": "i78buh",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "3bi6bj",
      "defaultMsg": "sdtiyb",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "o3byfx",
      "defaultMsg": "lc2lcl",
      "context": {
        "object": "any object"
      }
    }
  ]
}

29.8.1.53 企业年报网址
企业年报网址信息，包括网站名称、网址、网址类型、网址来源、审核时间等

Type: GET

Author: duwh

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

Description: 1.53 企业年报网址
企业年报网址信息，包括网站名称、网址、网址类型、网址来源、审核时间等

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

keyword

string

企业全名/注册号/统一社会信用代码

false

-

skip

string

跳过条目数（默认为0，单页返回20条数据）

false

-

Request-example:

curl -X GET -H 'Authorization' -i /api/qixin/getGetWebsitesUri?keyword=c7d4vu&skip=233.15.56.44

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "k11pjy",
      "defaultMsg": "1ydf44",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "ij2cu1",
      "defaultMsg": "vb2bm1",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "m2u868",
      "defaultMsg": "d4j27x",
      "context": {
        "object": "any object"
      }
    }
  ]
}

29.9.1.43 工商股东

Type: GET

Author: duwh

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

Description: 1.43 工商股东

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

keyword

string

企业全名/注册号/统一社会信用代码

false

-

skip

string

跳过条目数（默认为0，单页返回20条数据）

false

-

Request-example:

curl -X GET -H 'Authorization' -i /api/qixin/getPartners?keyword=y1ntwy&skip=233.15.56.44

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "k5habl",
      "defaultMsg": "8kvpe1",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "6z7pvz",
      "defaultMsg": "gsjp7j",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "e1kr4b",
      "defaultMsg": "oedzg2",
      "context": {
        "object": "any object"
      }
    }
  ]
}

29.10.1.45 主要人员
企业工商主要人员信息，包括主要人员姓名及职位

单价：0.1元/次

Type: GET

Author: duwh

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

Description: 1.45 主要人员
企业工商主要人员信息，包括主要人员姓名及职位

单价：0.1元/次

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

keyword

string

企业全名/注册号/统一社会信用代码

false

-

skip

string

跳过条目数（默认为0，单页返回20条数据）

false

-

Request-example:

curl -X GET -H 'Authorization' -i /api/qixin/getGetEmployees?keyword=xkezgb&skip=233.15.56.44

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "qw5ogs",
      "defaultMsg": "ijq4i0",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "tzf34t",
      "defaultMsg": "8ml4sw",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "w7jvzj",
      "defaultMsg": "sjouo8",
      "context": {
        "object": "any object"
      }
    }
  ]
}

30.消息类管理

30.1.新建

Type: POST

Author: wangding

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

Description: 新建

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

id

int64

No comments found.

false

-

remark

string

No comments found.

false

-

createUserId

int64

No comments found.

false

-

creator

string

记录创建者

false

-

createTime

string

No comments found.

false

-

modifyUserId

int64

No comments found.

false

-

modifyTime

string

No comments found.

false

-

deleteFlag

int32

No comments found.

false

-

ignoreWarning

boolean

No comments found.

false

-

nullFields

array

No comments found.

false

-

changeLogId

int64

No comments found.

false

-

remindCode

string

No comments found.

false

-

remindContent

string

No comments found.

false

-

remindContentLocale

string

No comments found.

false

-

remindType

string

No comments found.

false

-

portalFlag

boolean

No comments found.

false

-

Request-example:

curl -X POST -H 'Authorization' -i /API_SYSTEM/systemRemind --data 'id=651&remark=f0lgfe&createUserId=200&creator=snaezz&createTime=2023-09-27 17:34:58&modifyUserId=773&modifyTime=2023-09-27 17:34:58&deleteFlag=0&ignoreWarning=true&nullFields=p7qbrc,p7qbrc&changeLogId=75&remindCode=88129&remindContent=rtm5w3&remindContentLocale=en89yl&remindType=8ob5ks&portalFlag=true'

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "qe3nba",
      "defaultMsg": "qd2akw",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "vtxr5h",
      "defaultMsg": "cq8taa",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "h49vzo",
      "defaultMsg": "yfzpo1",
      "context": {
        "object": "any object"
      }
    }
  ]
}

30.2.清空消息提醒缓存

Type: GET

Author: wangding

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

Description: 清空消息提醒缓存

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Request-example:

curl -X GET -H 'Authorization' -i /API_SYSTEM/systemRemind/clearCache

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "0uwify",
      "defaultMsg": "37ig36",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "s66gfj",
      "defaultMsg": "yneg0y",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "pl9wwy",
      "defaultMsg": "ruyxgn",
      "context": {
        "object": "any object"
      }
    }
  ]
}

30.3.全部修改

Type: PUT

Author: wangding

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

Description: 全部修改

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

id

int64

No comments found.

false

-

remark

string

No comments found.

false

-

createUserId

int64

No comments found.

false

-

creator

string

记录创建者

false

-

createTime

string

No comments found.

false

-

modifyUserId

int64

No comments found.

false

-

modifyTime

string

No comments found.

false

-

deleteFlag

int32

No comments found.

false

-

ignoreWarning

boolean

No comments found.

false

-

nullFields

array

No comments found.

false

-

changeLogId

int64

No comments found.

false

-

remindCode

string

No comments found.

false

-

remindContent

string

No comments found.

false

-

remindContentLocale

string

No comments found.

false

-

remindType

string

No comments found.

false

-

portalFlag

boolean

No comments found.

false

-

Request-example:

curl -X PUT -H 'Authorization' -i /API_SYSTEM/systemRemind/overall --data 'id=25&remark=il2chk&createUserId=517&creator=mqn7vn&createTime=2023-09-27 17:34:58&modifyUserId=932&modifyTime=2023-09-27 17:34:58&deleteFlag=0&ignoreWarning=true&nullFields=cdh7h4,cdh7h4&changeLogId=79&remindCode=88129&remindContent=nnd67g&remindContentLocale=zefz4z&remindType=ermkgl&portalFlag=true'

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "vkfl2o",
      "defaultMsg": "k1f07a",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "rkf2e9",
      "defaultMsg": "mjac75",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "pky5vv",
      "defaultMsg": "05l6gt",
      "context": {
        "object": "any object"
      }
    }
  ]
}

30.4.物理删除

Type: DELETE

Author: wangding

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

Description: 物理删除

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

keys

array

主键,[array of int64]

false

-

Request-example:

curl -X DELETE -H 'Authorization' -i /API_SYSTEM/systemRemind?keys=ljriwf&keys=ljriwf

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "2qr1u5",
      "defaultMsg": "hstz52",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "g99fen",
      "defaultMsg": "8p4l7v",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "9wby4t",
      "defaultMsg": "952nmx",
      "context": {
        "object": "any object"
      }
    }
  ]
}

30.5.逻辑删除

Type: PATCH

Author: wangding

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

Description: 逻辑删除

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

keys

array

主键,[array of int64]

false

-

Request-example:

curl -X PATCH -H 'Authorization' -i /API_SYSTEM/systemRemind?keys=zlu2nm&keys=zlu2nm

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "ti7sqq",
      "defaultMsg": "2kjxgg",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "ac1jjw",
      "defaultMsg": "lje2kn",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "hdwr9a",
      "defaultMsg": "5gqnx5",
      "context": {
        "object": "any object"
      }
    }
  ]
}

30.6.根据主键查询

Type: GET

Author: wangding

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

Description: 根据主键查询

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Path-parameters:

ParameterTypeDescriptionRequiredSince

key

int64

主键

true

-

Request-example:

curl -X GET -H 'Authorization' -i /API_SYSTEM/systemRemind/474

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "t0fi50",
      "defaultMsg": "19zrsi",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "wc8yyc",
      "defaultMsg": "g3iyxo",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "ai7y1r",
      "defaultMsg": "toy59j",
      "context": {
        "object": "any object"
      }
    }
  ]
}

30.7.分页查询

Type: GET

Author: wangding

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

Description: 分页查询

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

current

int32

页码，默认为1

false

-

size

int32

页大小，默认为10

false

-

keyword

string

搜索关键字

false

-

idSet

object

ID

false

-

orders

array

排序

false

-

└─column

string

属性名称

false

-

└─asc

boolean

是否升序

false

-

id

int64

No comments found.

false

-

remark

string

No comments found.

false

-

createUserId

int64

No comments found.

false

-

loginUserId

int64

登录用户id 用于数据权限

false

-

createTimeStart

string

No comments found.

false

-

createTimeEnd

string

No comments found.

false

-

modifyUserId

int64

No comments found.

false

-

modifyTimeStart

string

No comments found.

false

-

modifyTimeEnd

string

No comments found.

false

-

dataPermissionFlag

boolean

No comments found.

false

-

remindCode

string

No comments found.

false

-

remindContent

string

No comments found.

false

-

remindContentLocale

string

No comments found.

false

-

remindType

string

No comments found.

false

-

portalFlag

boolean

No comments found.

false

-

Request-example:

curl -X GET -H 'Authorization' -i /API_SYSTEM/systemRemind/paging?current=238&size=10&keyword=8cb5yv&column=d7ia4b&asc=true&id=735&remark=3524bz&createUserId=21&loginUserId=853&createTimeStart=2023-09-27 17:34:58&createTimeEnd=2023-09-27 17:34:58&modifyUserId=458&modifyTimeStart=2023-09-27 17:34:58&modifyTimeEnd=2023-09-27 17:34:58&dataPermissionFlag=true&remindCode=88129&remindContent=z99egw&remindContentLocale=g5afdk&remindType=hb8ovn&portalFlag=true&orders[0].asc=true&orders[0].column=i7bmkl

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "dk0rgh",
      "defaultMsg": "l6hzti",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "5jdi69",
      "defaultMsg": "2eyhe7",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "4p3kva",
      "defaultMsg": "3az8i3",
      "context": {
        "object": "any object"
      }
    }
  ]
}

30.8.查询前端消息提醒

Type: GET

Author: wangding

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

Description: 查询前端消息提醒

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Request-example:

curl -X GET -H 'Authorization' -i /API_SYSTEM/systemRemind/portal

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "fwp8ou",
      "defaultMsg": "ye8tkf",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "vyh1ky",
      "defaultMsg": "orpyrf",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "wpcdog",
      "defaultMsg": "glr5cb",
      "context": {
        "object": "any object"
      }
    }
  ]
}

31.评论服务

31.1.新增

Type: POST

Author: duwh

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

Description: 新增

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

id

int64

No comments found.

false

-

remark

string

No comments found.

false

-

createUserId

int64

No comments found.

false

-

creator

string

记录创建者

false

-

createTime

string

No comments found.

false

-

modifyUserId

int64

No comments found.

false

-

modifyTime

string

No comments found.

false

-

deleteFlag

int32

No comments found.

false

-

ignoreWarning

boolean

No comments found.

false

-

nullFields

array

No comments found.

false

-

changeLogId

int64

No comments found.

false

-

objType

string

业务类型：枚举：经营计划：OPER_PLAN ....

false

-

objId

int64

业务主键

false

-

content

string

评论内容

false

-

annUserIds

string

安特@用户id集合 英文逗号隔开 11,22,33

false

-

userId

int64

评论人主键

false

-

userName

string

评论人姓名 冗余

false

-

userLogo

string

评论人头像 冗余

false

-

replyId

int64

回复对象主键

false

-

replyUserId

int64

回复人主键

false

-

replyUserName

string

回复人姓名 冗余

false

-

replyUserLogo

string

回复人头像 冗余

false

-

zanNum

int32

点赞数量

false

-

collectNum

int32

收藏数量

false

-

status

string

状态 预留

false

-

ext1

string

拓展1

false

-

ext2

string

拓展2

false

-

ext3

string

拓展3

false

-

ext4

string

拓展4

false

-

ext5

string

拓展5

false

-

Request-example:

curl -X POST -H 'Authorization' -i /api/system/comment --data 'id=864&remark=b1s0lj&createUserId=69&creator=pf17mj&createTime=2023-09-27 17:34:58&modifyUserId=799&modifyTime=2023-09-27 17:34:58&deleteFlag=0&ignoreWarning=true&nullFields=sp7tp4,sp7tp4&changeLogId=490&objType=5g7gqp&objId=181&content=msklw6&annUserIds=89&userId=339&userName=gil.paucek&userLogo=nzpmu8&replyId=818&replyUserId=80&replyUserName=gil.paucek&replyUserLogo=2sj4ey&zanNum=88&collectNum=78&status=rc2v9r&ext1=jqhxx8&ext2=umpmrb&ext3=eo22i2&ext4=zazps8&ext5=gkho1b'

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "zmib6w",
      "defaultMsg": "14tgqq",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "vssfkm",
      "defaultMsg": "6jlb0c",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "9cpt83",
      "defaultMsg": "jmmctd",
      "context": {
        "object": "any object"
      }
    }
  ]
}

31.2.更新

Type: PUT

Author: duwh

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

Description: 更新

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

id

int64

No comments found.

false

-

remark

string

No comments found.

false

-

createUserId

int64

No comments found.

false

-

creator

string

记录创建者

false

-

createTime

string

No comments found.

false

-

modifyUserId

int64

No comments found.

false

-

modifyTime

string

No comments found.

false

-

deleteFlag

int32

No comments found.

false

-

ignoreWarning

boolean

No comments found.

false

-

nullFields

array

No comments found.

false

-

changeLogId

int64

No comments found.

false

-

objType

string

业务类型：枚举：经营计划：OPER_PLAN ....

false

-

objId

int64

业务主键

false

-

content

string

评论内容

false

-

annUserIds

string

安特@用户id集合 英文逗号隔开 11,22,33

false

-

userId

int64

评论人主键

false

-

userName

string

评论人姓名 冗余

false

-

userLogo

string

评论人头像 冗余

false

-

replyId

int64

回复对象主键

false

-

replyUserId

int64

回复人主键

false

-

replyUserName

string

回复人姓名 冗余

false

-

replyUserLogo

string

回复人头像 冗余

false

-

zanNum

int32

点赞数量

false

-

collectNum

int32

收藏数量

false

-

status

string

状态 预留

false

-

ext1

string

拓展1

false

-

ext2

string

拓展2

false

-

ext3

string

拓展3

false

-

ext4

string

拓展4

false

-

ext5

string

拓展5

false

-

Request-example:

curl -X PUT -H 'Authorization' -i /api/system/comment --data 'id=806&remark=ffn3dh&createUserId=997&creator=lznt88&createTime=2023-09-27 17:34:58&modifyUserId=991&modifyTime=2023-09-27 17:34:58&deleteFlag=0&ignoreWarning=true&nullFields=94d4qm,94d4qm&changeLogId=291&objType=7v8qv0&objId=794&content=tb4xj8&annUserIds=89&userId=647&userName=gil.paucek&userLogo=rwumxs&replyId=419&replyUserId=992&replyUserName=gil.paucek&replyUserLogo=upqul0&zanNum=637&collectNum=939&status=3t7s02&ext1=mb5tqv&ext2=1lam1u&ext3=0uylpd&ext4=34st5s&ext5=yq44eo'

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "61ii7z",
      "defaultMsg": "cb4z2d",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "y997jn",
      "defaultMsg": "hprvka",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "xhknps",
      "defaultMsg": "rzr6ah",
      "context": {
        "object": "any object"
      }
    }
  ]
}

31.3.主键查询

Type: GET

Author: duwh

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

Description: 主键查询

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Path-parameters:

ParameterTypeDescriptionRequiredSince

key

int64

关键

true

-

Request-example:

curl -X GET -H 'Authorization' -i /api/system/comment/727

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "67g2w9",
      "defaultMsg": "vy4qvk",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "yaafvv",
      "defaultMsg": "xl3i57",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "0c6n25",
      "defaultMsg": "utf7xo",
      "context": {
        "object": "any object"
      }
    }
  ]
}

31.4.分页

Type: GET

Author: duwh

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

Description: 分页

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

current

int32

页码，默认为1

false

-

size

int32

页大小，默认为10

false

-

keyword

string

搜索关键字

false

-

idSet

object

ID

false

-

orders

array

排序

false

-

└─column

string

属性名称

false

-

└─asc

boolean

是否升序

false

-

id

int64

No comments found.

false

-

remark

string

No comments found.

false

-

createUserId

int64

No comments found.

false

-

loginUserId

int64

登录用户id 用于数据权限

false

-

createTimeStart

string

No comments found.

false

-

createTimeEnd

string

No comments found.

false

-

modifyUserId

int64

No comments found.

false

-

modifyTimeStart

string

No comments found.

false

-

modifyTimeEnd

string

No comments found.

false

-

dataPermissionFlag

boolean

No comments found.

false

-

objType

string

业务类型：枚举：经营计划：OPER_PLAN ....

false

-

objId

int64

业务主键

false

-

content

string

评论内容

false

-

userId

int64

评论人主键

false

-

userName

string

评论人姓名 冗余

false

-

userLogo

string

评论人头像 冗余

false

-

replyId

int64

回复对象主键

false

-

replyUserId

int64

回复人主键

false

-

replyUserName

string

回复人姓名 冗余

false

-

replyUserLogo

string

回复人头像 冗余

false

-

zanNum

int32

点赞数量

false

-

collectNum

int32

收藏数量

false

-

status

string

状态 预留

false

-

ext1

string

拓展1

false

-

ext2

string

拓展2

false

-

ext3

string

拓展3

false

-

ext4

string

拓展4

false

-

ext5

string

拓展5

false

-

Request-example:

curl -X GET -H 'Authorization' -i /api/system/comment/paging?current=771&size=10&keyword=s1m0co&column=q1d61c&asc=true&id=42&remark=oivyth&createUserId=251&loginUserId=624&createTimeStart=2023-09-27 17:34:58&createTimeEnd=2023-09-27 17:34:58&modifyUserId=39&modifyTimeStart=2023-09-27 17:34:58&modifyTimeEnd=2023-09-27 17:34:58&dataPermissionFlag=true&objType=2tepcr&objId=531&content=94ofqs&userId=451&userName=gil.paucek&userLogo=4gwyql&replyId=3&replyUserId=220&replyUserName=gil.paucek&replyUserLogo=47hzek&zanNum=877&collectNum=914&status=isj4g9&ext1=zfn8br&ext2=p7rb9f&ext3=fgo7at&ext4=lw8qys&ext5=zbtqeu&orders[0].asc=true&orders[0].column=7hzvsl

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "fbdu0b",
      "defaultMsg": "8v43yr",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "3c9rkm",
      "defaultMsg": "prgin8",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "t6ycqy",
      "defaultMsg": "corg22",
      "context": {
        "object": "any object"
      }
    }
  ]
}

31.5.分页带层级 包含二级评论

Type: GET

Author: duwh

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

Description: 分页带层级 包含二级评论

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

current

int32

页码，默认为1

false

-

size

int32

页大小，默认为10

false

-

keyword

string

搜索关键字

false

-

idSet

object

ID

false

-

orders

array

排序

false

-

└─column

string

属性名称

false

-

└─asc

boolean

是否升序

false

-

id

int64

No comments found.

false

-

remark

string

No comments found.

false

-

createUserId

int64

No comments found.

false

-

loginUserId

int64

登录用户id 用于数据权限

false

-

createTimeStart

string

No comments found.

false

-

createTimeEnd

string

No comments found.

false

-

modifyUserId

int64

No comments found.

false

-

modifyTimeStart

string

No comments found.

false

-

modifyTimeEnd

string

No comments found.

false

-

dataPermissionFlag

boolean

No comments found.

false

-

objType

string

业务类型：枚举：经营计划：OPER_PLAN ....

false

-

objId

int64

业务主键

false

-

content

string

评论内容

false

-

userId

int64

评论人主键

false

-

userName

string

评论人姓名 冗余

false

-

userLogo

string

评论人头像 冗余

false

-

replyId

int64

回复对象主键

false

-

replyUserId

int64

回复人主键

false

-

replyUserName

string

回复人姓名 冗余

false

-

replyUserLogo

string

回复人头像 冗余

false

-

zanNum

int32

点赞数量

false

-

collectNum

int32

收藏数量

false

-

status

string

状态 预留

false

-

ext1

string

拓展1

false

-

ext2

string

拓展2

false

-

ext3

string

拓展3

false

-

ext4

string

拓展4

false

-

ext5

string

拓展5

false

-

Request-example:

curl -X GET -H 'Authorization' -i /api/system/comment/pagingPro?current=209&size=10&keyword=mi3ab1&column=n3ynjh&asc=true&id=785&remark=0ogqzm&createUserId=268&loginUserId=78&createTimeStart=2023-09-27 17:34:58&createTimeEnd=2023-09-27 17:34:58&modifyUserId=896&modifyTimeStart=2023-09-27 17:34:58&modifyTimeEnd=2023-09-27 17:34:58&dataPermissionFlag=true&objType=a9m83v&objId=74&content=ejavis&userId=350&userName=gil.paucek&userLogo=5s35io&replyId=981&replyUserId=269&replyUserName=gil.paucek&replyUserLogo=982wop&zanNum=511&collectNum=574&status=t2qetk&ext1=j8zd0o&ext2=zl6qts&ext3=4c27sp&ext4=prrhns&ext5=dzlixo&orders[0].column=hyi7gd&orders[0].asc=true

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "3ypcqn",
      "defaultMsg": "a4e5yr",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "bkin23",
      "defaultMsg": "ontm36",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "b6rrxv",
      "defaultMsg": "zkmo1a",
      "context": {
        "object": "any object"
      }
    }
  ]
}

31.6.查询列表
带层级 包含二级评论

Type: GET

Author: duwh

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

Description: 查询列表
带层级 包含二级评论

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

current

int32

页码，默认为1

false

-

size

int32

页大小，默认为10

false

-

keyword

string

搜索关键字

false

-

idSet

object

ID

false

-

orders

array

排序

false

-

└─column

string

属性名称

false

-

└─asc

boolean

是否升序

false

-

id

int64

No comments found.

false

-

remark

string

No comments found.

false

-

createUserId

int64

No comments found.

false

-

loginUserId

int64

登录用户id 用于数据权限

false

-

createTimeStart

string

No comments found.

false

-

createTimeEnd

string

No comments found.

false

-

modifyUserId

int64

No comments found.

false

-

modifyTimeStart

string

No comments found.

false

-

modifyTimeEnd

string

No comments found.

false

-

dataPermissionFlag

boolean

No comments found.

false

-

objType

string

业务类型：枚举：经营计划：OPER_PLAN ....

false

-

objId

int64

业务主键

false

-

content

string

评论内容

false

-

userId

int64

评论人主键

false

-

userName

string

评论人姓名 冗余

false

-

userLogo

string

评论人头像 冗余

false

-

replyId

int64

回复对象主键

false

-

replyUserId

int64

回复人主键

false

-

replyUserName

string

回复人姓名 冗余

false

-

replyUserLogo

string

回复人头像 冗余

false

-

zanNum

int32

点赞数量

false

-

collectNum

int32

收藏数量

false

-

status

string

状态 预留

false

-

ext1

string

拓展1

false

-

ext2

string

拓展2

false

-

ext3

string

拓展3

false

-

ext4

string

拓展4

false

-

ext5

string

拓展5

false

-

Request-example:

curl -X GET -H 'Authorization' -i /api/system/comment/listPro?current=471&size=10&keyword=m19hz3&column=zvlrxj&asc=true&id=773&remark=1181gd&createUserId=130&loginUserId=541&createTimeStart=2023-09-27 17:34:58&createTimeEnd=2023-09-27 17:34:58&modifyUserId=606&modifyTimeStart=2023-09-27 17:34:58&modifyTimeEnd=2023-09-27 17:34:58&dataPermissionFlag=true&objType=5kpbgm&objId=739&content=f9ynf5&userId=574&userName=gil.paucek&userLogo=24nqqy&replyId=770&replyUserId=213&replyUserName=gil.paucek&replyUserLogo=9quyss&zanNum=694&collectNum=775&status=1q4tk7&ext1=ivzqdl&ext2=hbd7n4&ext3=0a6yd3&ext4=hznpwo&ext5=eg14hx&orders[0].asc=true&orders[0].column=puw5kc

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "nssfdf",
      "defaultMsg": "gs31xq",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "crdmyl",
      "defaultMsg": "0v78wt",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "oxygts",
      "defaultMsg": "i70y99",
      "context": {
        "object": "any object"
      }
    }
  ]
}

31.7.查询列表

Type: GET

Author: duwh

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

Description: 查询列表

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

current

int32

页码，默认为1

false

-

size

int32

页大小，默认为10

false

-

keyword

string

搜索关键字

false

-

idSet

object

ID

false

-

orders

array

排序

false

-

└─column

string

属性名称

false

-

└─asc

boolean

是否升序

false

-

id

int64

No comments found.

false

-

remark

string

No comments found.

false

-

createUserId

int64

No comments found.

false

-

loginUserId

int64

登录用户id 用于数据权限

false

-

createTimeStart

string

No comments found.

false

-

createTimeEnd

string

No comments found.

false

-

modifyUserId

int64

No comments found.

false

-

modifyTimeStart

string

No comments found.

false

-

modifyTimeEnd

string

No comments found.

false

-

dataPermissionFlag

boolean

No comments found.

false

-

objType

string

业务类型：枚举：经营计划：OPER_PLAN ....

false

-

objId

int64

业务主键

false

-

content

string

评论内容

false

-

userId

int64

评论人主键

false

-

userName

string

评论人姓名 冗余

false

-

userLogo

string

评论人头像 冗余

false

-

replyId

int64

回复对象主键

false

-

replyUserId

int64

回复人主键

false

-

replyUserName

string

回复人姓名 冗余

false

-

replyUserLogo

string

回复人头像 冗余

false

-

zanNum

int32

点赞数量

false

-

collectNum

int32

收藏数量

false

-

status

string

状态 预留

false

-

ext1

string

拓展1

false

-

ext2

string

拓展2

false

-

ext3

string

拓展3

false

-

ext4

string

拓展4

false

-

ext5

string

拓展5

false

-

Request-example:

curl -X GET -H 'Authorization' -i /api/system/comment/list?current=654&size=10&keyword=vmb0qo&column=zc1vl0&asc=true&id=956&remark=gsekww&createUserId=564&loginUserId=827&createTimeStart=2023-09-27 17:34:58&createTimeEnd=2023-09-27 17:34:58&modifyUserId=241&modifyTimeStart=2023-09-27 17:34:58&modifyTimeEnd=2023-09-27 17:34:58&dataPermissionFlag=true&objType=d80j1h&objId=325&content=6z1ip1&userId=581&userName=gil.paucek&userLogo=i14pvt&replyId=81&replyUserId=703&replyUserName=gil.paucek&replyUserLogo=ts9h4c&zanNum=79&collectNum=815&status=rd7jl4&ext1=ahvok7&ext2=5i24gl&ext3=azcw7r&ext4=cx4c3g&ext5=4l65ep&orders[0].column=kpzdk6&orders[0].asc=true

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "s35ydg",
      "defaultMsg": "nvky0j",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "0siryr",
      "defaultMsg": "js1h89",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "ns58gp",
      "defaultMsg": "10iz0w",
      "context": {
        "object": "any object"
      }
    }
  ]
}

31.8.删除

Type: DELETE

Author: duwh

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

Description: 删除

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

keys

array

主键id,[array of int64]

false

-

Request-example:

curl -X DELETE -H 'Authorization' -i /api/system/comment/deleteSoft?keys=3mmbqj&keys=3mmbqj

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "g0j6mi",
      "defaultMsg": "kilrl1",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "uw13pk",
      "defaultMsg": "eut890",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "b0wylk",
      "defaultMsg": "mqwun7",
      "context": {
        "object": "any object"
      }
    }
  ]
}

32.系统选择项管理

32.1.新建

Type: POST

Author: wangding

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

Description: 新建

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

id

int64

No comments found.

false

-

remark

string

No comments found.

false

-

createUserId

int64

No comments found.

false

-

creator

string

记录创建者

false

-

createTime

string

No comments found.

false

-

modifyUserId

int64

No comments found.

false

-

modifyTime

string

No comments found.

false

-

deleteFlag

int32

No comments found.

false

-

ignoreWarning

boolean

No comments found.

false

-

nullFields

array

No comments found.

false

-

changeLogId

int64

No comments found.

false

-

functionId

int64

No comments found.

false

-

selectionKey

string

No comments found.

false

-

selectionName

string

No comments found.

false

-

selectionNameLocale

string

No comments found.

false

-

selectionValue

string

No comments found.

false

-

parentId

int64

No comments found.

false

-

sortNo

int32

No comments found.

false

-

allowChange

string

No comments found.

false

-

extString1

string

No comments found.

false

-

extString2

string

No comments found.

false

-

extString3

string

No comments found.

false

-

extString4

string

No comments found.

false

-

extString5

string

No comments found.

false

-

extString6

string

No comments found.

false

-

extString7

string

No comments found.

false

-

extString8

string

No comments found.

false

-

extString9

string

No comments found.

false

-

extString10

string

No comments found.

false

-

Request-example:

curl -X POST -H 'Authorization' -i /api/system/systemSelection --data 'id=139&remark=16w0x6&createUserId=59&creator=j0u7n4&createTime=2023-09-27 17:34:58&modifyUserId=969&modifyTime=2023-09-27 17:34:58&deleteFlag=0&ignoreWarning=true&nullFields=dd2zhi,dd2zhi&changeLogId=77&functionId=454&selectionKey=52vvdi&selectionName=gil.paucek&selectionNameLocale=b510lw&selectionValue=ecpxil&parentId=396&sortNo=741&allowChange=1i0lvr&extString1=uscfle&extString2=yvgjqr&extString3=6yilqu&extString4=rvpg75&extString5=00iowv&extString6=jwuu71&extString7=t29wb9&extString8=441iy7&extString9=2ya9rd&extString10=i5s1n2'

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "vx9sry",
      "defaultMsg": "e7gzo3",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "66svcg",
      "defaultMsg": "jbcejt",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "kfhv35",
      "defaultMsg": "bvr4h5",
      "context": {
        "object": "any object"
      }
    }
  ]
}

32.2.清空消息提醒缓存

Type: GET

Author: wangding

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

Description: 清空消息提醒缓存

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Request-example:

curl -X GET -H 'Authorization' -i /api/system/systemSelection/clearCache

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "2yemgk",
      "defaultMsg": "ck88r1",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "qqpf2s",
      "defaultMsg": "bwo7pe",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "of7lc6",
      "defaultMsg": "fvdndb",
      "context": {
        "object": "any object"
      }
    }
  ]
}

32.3.全部修改

Type: PUT

Author: wangding

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

Description: 全部修改

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

id

int64

No comments found.

false

-

remark

string

No comments found.

false

-

createUserId

int64

No comments found.

false

-

creator

string

记录创建者

false

-

createTime

string

No comments found.

false

-

modifyUserId

int64

No comments found.

false

-

modifyTime

string

No comments found.

false

-

deleteFlag

int32

No comments found.

false

-

ignoreWarning

boolean

No comments found.

false

-

nullFields

array

No comments found.

false

-

changeLogId

int64

No comments found.

false

-

functionId

int64

No comments found.

false

-

selectionKey

string

No comments found.

false

-

selectionName

string

No comments found.

false

-

selectionNameLocale

string

No comments found.

false

-

selectionValue

string

No comments found.

false

-

parentId

int64

No comments found.

false

-

sortNo

int32

No comments found.

false

-

allowChange

string

No comments found.

false

-

extString1

string

No comments found.

false

-

extString2

string

No comments found.

false

-

extString3

string

No comments found.

false

-

extString4

string

No comments found.

false

-

extString5

string

No comments found.

false

-

extString6

string

No comments found.

false

-

extString7

string

No comments found.

false

-

extString8

string

No comments found.

false

-

extString9

string

No comments found.

false

-

extString10

string

No comments found.

false

-

Request-example:

curl -X PUT -H 'Authorization' -i /api/system/systemSelection --data 'id=781&remark=v329r3&createUserId=907&creator=6ruhrh&createTime=2023-09-27 17:34:58&modifyUserId=842&modifyTime=2023-09-27 17:34:58&deleteFlag=0&ignoreWarning=true&nullFields=bxwb8o,bxwb8o&changeLogId=64&functionId=571&selectionKey=qxt5eg&selectionName=gil.paucek&selectionNameLocale=b6hp4r&selectionValue=9quyxr&parentId=927&sortNo=870&allowChange=md5xm9&extString1=9h782e&extString2=yktq0q&extString3=uya0y5&extString4=cbould&extString5=gpg0ow&extString6=uvdbo3&extString7=2v6yww&extString8=ewzq0y&extString9=4gkg8k&extString10=wcs3j9'

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "3ixf64",
      "defaultMsg": "4fjncn",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "uh4t5j",
      "defaultMsg": "pkeg59",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "nsh8ac",
      "defaultMsg": "47m3s4",
      "context": {
        "object": "any object"
      }
    }
  ]
}

32.4.物理删除

Type: DELETE

Author: wangding

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

Description: 物理删除

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

keys

array

主键,[array of int64]

false

-

Request-example:

curl -X DELETE -H 'Authorization' -i /api/system/systemSelection?keys=9lof1l&keys=9lof1l

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "iil4zm",
      "defaultMsg": "rxovhq",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "4cl7eb",
      "defaultMsg": "apspaz",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "6p6yod",
      "defaultMsg": "xj2wfa",
      "context": {
        "object": "any object"
      }
    }
  ]
}

32.5.逻辑删除

Type: PATCH

Author: wangding

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

Description: 逻辑删除

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

keys

array

主键,[array of int64]

false

-

Request-example:

curl -X PATCH -H 'Authorization' -i /api/system/systemSelection?keys=k6m3wk&keys=k6m3wk

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "1yworx",
      "defaultMsg": "fpatxd",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "13m75e",
      "defaultMsg": "i4fu51",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "10gytu",
      "defaultMsg": "gharzf",
      "context": {
        "object": "any object"
      }
    }
  ]
}

32.6.根据主键查询

Type: GET

Author: wangding

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

Description: 根据主键查询

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Path-parameters:

ParameterTypeDescriptionRequiredSince

key

int64

主键

true

-

Request-example:

curl -X GET -H 'Authorization' -i /api/system/systemSelection/19

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "brbqyb",
      "defaultMsg": "7bw5mn",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "779v08",
      "defaultMsg": "vicazd",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "4p9w1c",
      "defaultMsg": "n4syef",
      "context": {
        "object": "any object"
      }
    }
  ]
}

32.7.分页查询

Type: GET

Author: wangding

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

Description: 分页查询

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

current

int32

页码，默认为1

false

-

size

int32

页大小，默认为10

false

-

keyword

string

搜索关键字

false

-

idSet

object

ID

false

-

orders

array

排序

false

-

└─column

string

属性名称

false

-

└─asc

boolean

是否升序

false

-

id

int64

No comments found.

false

-

remark

string

No comments found.

false

-

createUserId

int64

No comments found.

false

-

loginUserId

int64

登录用户id 用于数据权限

false

-

createTimeStart

string

No comments found.

false

-

createTimeEnd

string

No comments found.

false

-

modifyUserId

int64

No comments found.

false

-

modifyTimeStart

string

No comments found.

false

-

modifyTimeEnd

string

No comments found.

false

-

dataPermissionFlag

boolean

No comments found.

false

-

functionId

int64

No comments found.

false

-

selectionKey

string

No comments found.

false

-

parentSelectionKey

string

父节点selectionKey

false

-

selectionName

string

No comments found.

false

-

selectionNameLocale

string

No comments found.

false

-

selectionValue

string

No comments found.

false

-

parentId

int64

No comments found.

false

-

sortNo

int32

No comments found.

false

-

allowChange

string

No comments found.

false

-

extString1

string

No comments found.

false

-

extString2

string

No comments found.

false

-

extString3

string

No comments found.

false

-

extString4

string

No comments found.

false

-

extString5

string

No comments found.

false

-

extString6

string

No comments found.

false

-

extString7

string

No comments found.

false

-

extString8

string

No comments found.

false

-

extString9

string

No comments found.

false

-

extString10

string

省市区层级，1省，2市，3区

false

-

Request-example:

curl -X GET -H 'Authorization' -i /api/system/systemSelection/paging?current=346&size=10&keyword=l07dz7&column=g04pul&asc=true&id=454&remark=kfchd0&createUserId=610&loginUserId=49&createTimeStart=2023-09-27 17:34:58&createTimeEnd=2023-09-27 17:34:58&modifyUserId=690&modifyTimeStart=2023-09-27 17:34:58&modifyTimeEnd=2023-09-27 17:34:58&dataPermissionFlag=true&functionId=372&selectionKey=gjhsie&parentSelectionKey=z6xe65&selectionName=gil.paucek&selectionNameLocale=vv1luv&selectionValue=fdp0xi&parentId=972&sortNo=740&allowChange=lpmm93&extString1=pnbwgd&extString2=pg19tm&extString3=q5nuf1&extString4=exi21t&extString5=o0wsnl&extString6=8vrw0u&extString7=ul1xf6&extString8=pj6vk0&extString9=7uz2lt&extString10=mp7290&orders[0].column=vx0xo9&orders[0].asc=true

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "na80un",
      "defaultMsg": "pj0njh",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "49tvbv",
      "defaultMsg": "ra6r9s",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "zfnbfk",
      "defaultMsg": "11yjhv",
      "context": {
        "object": "any object"
      }
    }
  ]
}

32.8.列表查询

Type: GET

Author: wangding

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

Description: 列表查询

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

current

int32

页码，默认为1

false

-

size

int32

页大小，默认为10

false

-

keyword

string

搜索关键字

false

-

idSet

object

ID

false

-

orders

array

排序

false

-

└─column

string

属性名称

false

-

└─asc

boolean

是否升序

false

-

id

int64

No comments found.

false

-

remark

string

No comments found.

false

-

createUserId

int64

No comments found.

false

-

loginUserId

int64

登录用户id 用于数据权限

false

-

createTimeStart

string

No comments found.

false

-

createTimeEnd

string

No comments found.

false

-

modifyUserId

int64

No comments found.

false

-

modifyTimeStart

string

No comments found.

false

-

modifyTimeEnd

string

No comments found.

false

-

dataPermissionFlag

boolean

No comments found.

false

-

functionId

int64

No comments found.

false

-

selectionKey

string

No comments found.

false

-

parentSelectionKey

string

父节点selectionKey

false

-

selectionName

string

No comments found.

false

-

selectionNameLocale

string

No comments found.

false

-

selectionValue

string

No comments found.

false

-

parentId

int64

No comments found.

false

-

sortNo

int32

No comments found.

false

-

allowChange

string

No comments found.

false

-

extString1

string

No comments found.

false

-

extString2

string

No comments found.

false

-

extString3

string

No comments found.

false

-

extString4

string

No comments found.

false

-

extString5

string

No comments found.

false

-

extString6

string

No comments found.

false

-

extString7

string

No comments found.

false

-

extString8

string

No comments found.

false

-

extString9

string

No comments found.

false

-

extString10

string

省市区层级，1省，2市，3区

false

-

Request-example:

curl -X GET -H 'Authorization' -i /api/system/systemSelection/list?current=700&size=10&keyword=b9gvnz&column=uoj1hf&asc=true&id=559&remark=6rquc7&createUserId=705&loginUserId=660&createTimeStart=2023-09-27 17:34:58&createTimeEnd=2023-09-27 17:34:58&modifyUserId=267&modifyTimeStart=2023-09-27 17:34:58&modifyTimeEnd=2023-09-27 17:34:58&dataPermissionFlag=true&functionId=551&selectionKey=qczmu5&parentSelectionKey=jwvnpr&selectionName=gil.paucek&selectionNameLocale=8xfh3h&selectionValue=3193fl&parentId=206&sortNo=496&allowChange=c03dvf&extString1=tkdnt2&extString2=dtmj8j&extString3=njoz22&extString4=iq6jjp&extString5=skqkfs&extString6=kpg3k9&extString7=hnnjw0&extString8=9txvui&extString9=6oomzq&extString10=852ogs&orders[0].asc=true&orders[0].column=6e51as

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "stpjeh",
      "defaultMsg": "usfbtx",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "3sx0a7",
      "defaultMsg": "acnrhw",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "45soza",
      "defaultMsg": "asy5ct",
      "context": {
        "object": "any object"
      }
    }
  ]
}

32.9.通过KEY查询直属子集

Type: GET

Author: wangding

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

Description: 通过KEY查询直属子集

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Path-parameters:

ParameterTypeDescriptionRequiredSince

key

string

下拉选择key

true

-

Request-example:

curl -X GET -H 'Authorization' -i /api/system/systemSelection/byKey/u02ajz

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "me4khu",
      "defaultMsg": "qmbeai",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "0hslg8",
      "defaultMsg": "sn2sp3",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "fw0b2v",
      "defaultMsg": "fszx4a",
      "context": {
        "object": "any object"
      }
    }
  ]
}

32.10.通过KEY查询树状子集

Type: GET

Author: wangding

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

Description: 通过KEY查询树状子集

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Path-parameters:

ParameterTypeDescriptionRequiredSince

key

string

下拉选择key

true

-

Request-example:

curl -X GET -H 'Authorization' -i /api/system/systemSelection/byKeyAll/i2oxq0

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "86ni0s",
      "defaultMsg": "4fym4m",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "6oxe3v",
      "defaultMsg": "ni64an",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "pm5ga8",
      "defaultMsg": "1ey2mj",
      "context": {
        "object": "any object"
      }
    }
  ]
}

32.11.根据父节点key查询子节点list，可以对子节点进行过滤

Type: GET

Author: wangding

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

Description: 根据父节点key查询子节点list，可以对子节点进行过滤

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

current

int32

页码，默认为1

false

-

size

int32

页大小，默认为10

false

-

keyword

string

搜索关键字

false

-

idSet

object

ID

false

-

orders

array

排序

false

-

└─column

string

属性名称

false

-

└─asc

boolean

是否升序

false

-

id

int64

No comments found.

false

-

remark

string

No comments found.

false

-

createUserId

int64

No comments found.

false

-

loginUserId

int64

登录用户id 用于数据权限

false

-

createTimeStart

string

No comments found.

false

-

createTimeEnd

string

No comments found.

false

-

modifyUserId

int64

No comments found.

false

-

modifyTimeStart

string

No comments found.

false

-

modifyTimeEnd

string

No comments found.

false

-

dataPermissionFlag

boolean

No comments found.

false

-

functionId

int64

No comments found.

false

-

selectionKey

string

No comments found.

false

-

parentSelectionKey

string

父节点selectionKey

false

-

selectionName

string

No comments found.

false

-

selectionNameLocale

string

No comments found.

false

-

selectionValue

string

No comments found.

false

-

parentId

int64

No comments found.

false

-

sortNo

int32

No comments found.

false

-

allowChange

string

No comments found.

false

-

extString1

string

No comments found.

false

-

extString2

string

No comments found.

false

-

extString3

string

No comments found.

false

-

extString4

string

No comments found.

false

-

extString5

string

No comments found.

false

-

extString6

string

No comments found.

false

-

extString7

string

No comments found.

false

-

extString8

string

No comments found.

false

-

extString9

string

No comments found.

false

-

extString10

string

省市区层级，1省，2市，3区

false

-

Request-example:

curl -X GET -H 'Authorization' -i /api/system/systemSelection/childrenList?current=167&size=10&keyword=rirzao&column=rribfz&asc=true&id=9&remark=7y9119&createUserId=105&loginUserId=135&createTimeStart=2023-09-27 17:34:58&createTimeEnd=2023-09-27 17:34:58&modifyUserId=218&modifyTimeStart=2023-09-27 17:34:58&modifyTimeEnd=2023-09-27 17:34:58&dataPermissionFlag=true&functionId=467&selectionKey=1zwsjr&parentSelectionKey=6lkwjk&selectionName=gil.paucek&selectionNameLocale=9gs1f7&selectionValue=bj0w8c&parentId=149&sortNo=82&allowChange=7p7uq0&extString1=rkuyrt&extString2=00mpyp&extString3=wpcdwf&extString4=lazung&extString5=fskhy9&extString6=qi3cuf&extString7=59c6su&extString8=z7l7lu&extString9=k4ejx1&extString10=6e0y5q&orders[0].asc=true&orders[0].column=qb7394

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "e2gvpb",
      "defaultMsg": "h00och",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "xp1mgc",
      "defaultMsg": "11ppa1",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "99buq0",
      "defaultMsg": "13h143",
      "context": {
        "object": "any object"
      }
    }
  ]
}

32.12.查询级联系统选择项

Type: GET

Author: wangding

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

Description: 查询级联系统选择项

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

key

string

下拉选择key

false

-

cascaderValues

array

级联各级值,[array of string]

false

-

Request-example:

curl -X GET -H 'Authorization' -i /api/system/systemSelection/cascader?key=0696ea&cascaderValues=ofux3r&cascaderValues=ofux3r

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "ddlxiw",
      "defaultMsg": "hnhdgq",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "4tjtdp",
      "defaultMsg": "shcai0",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "9777t6",
      "defaultMsg": "rbooj7",
      "context": {
        "object": "any object"
      }
    }
  ]
}

33.系统标签项管理

33.1.新建

Type: POST

Author: wangding

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

Description: 新建

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

id

int64

No comments found.

false

-

remark

string

No comments found.

false

-

createUserId

int64

No comments found.

false

-

creator

string

记录创建者

false

-

createTime

string

No comments found.

false

-

modifyUserId

int64

No comments found.

false

-

modifyTime

string

No comments found.

false

-

deleteFlag

int32

No comments found.

false

-

ignoreWarning

boolean

No comments found.

false

-

nullFields

array

No comments found.

false

-

changeLogId

int64

No comments found.

false

-

functionId

int64

功能ID

false

-

tagKey

string

标签KEY

false

-

tagName

string

标签名称

false

-

tagNameLocale

string

标签内容国际化

false

-

tagColor

string

标签颜色

false

-

sceneNo

string

场景编号

false

-

enabled

boolean

启用状态

false

-

sortIndex

int32

排序号

false

-

extString1

string

No comments found.

false

-

extString2

string

No comments found.

false

-

extString3

string

No comments found.

false

-

extString4

string

No comments found.

false

-

extString5

string

No comments found.

false

-

extString6

string

No comments found.

false

-

extString7

string

No comments found.

false

-

extString8

string

No comments found.

false

-

extString9

string

No comments found.

false

-

extString10

string

No comments found.

false

-

Request-example:

curl -X POST -H 'Authorization' -i /api/system/tag --data 'id=738&remark=dt6pf6&createUserId=760&creator=4cavwl&createTime=2023-09-27 17:34:58&modifyUserId=206&modifyTime=2023-09-27 17:34:58&deleteFlag=0&ignoreWarning=true&nullFields=jg81pm,jg81pm&changeLogId=496&functionId=776&tagKey=fmpiml&tagName=gil.paucek&tagNameLocale=nurrso&tagColor=a5ubh5&sceneNo=g52bw0&enabled=true&sortIndex=1&extString1=u8iwba&extString2=f61k7l&extString3=mivt8h&extString4=a8wvza&extString5=sh4fwy&extString6=a8i16n&extString7=i4sii7&extString8=b2rk92&extString9=85pbwh&extString10=eks8av'

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "a50r8h",
      "defaultMsg": "05gqye",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "e0rvmo",
      "defaultMsg": "04t7rz",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "21w8g7",
      "defaultMsg": "cyrwmt",
      "context": {
        "object": "any object"
      }
    }
  ]
}

33.2.全部修改

Type: PUT

Author: wangding

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

Description: 全部修改

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

id

int64

No comments found.

false

-

remark

string

No comments found.

false

-

createUserId

int64

No comments found.

false

-

creator

string

记录创建者

false

-

createTime

string

No comments found.

false

-

modifyUserId

int64

No comments found.

false

-

modifyTime

string

No comments found.

false

-

deleteFlag

int32

No comments found.

false

-

ignoreWarning

boolean

No comments found.

false

-

nullFields

array

No comments found.

false

-

changeLogId

int64

No comments found.

false

-

functionId

int64

功能ID

false

-

tagKey

string

标签KEY

false

-

tagName

string

标签名称

false

-

tagNameLocale

string

标签内容国际化

false

-

tagColor

string

标签颜色

false

-

sceneNo

string

场景编号

false

-

enabled

boolean

启用状态

false

-

sortIndex

int32

排序号

false

-

extString1

string

No comments found.

false

-

extString2

string

No comments found.

false

-

extString3

string

No comments found.

false

-

extString4

string

No comments found.

false

-

extString5

string

No comments found.

false

-

extString6

string

No comments found.

false

-

extString7

string

No comments found.

false

-

extString8

string

No comments found.

false

-

extString9

string

No comments found.

false

-

extString10

string

No comments found.

false

-

Request-example:

curl -X PUT -H 'Authorization' -i /api/system/tag --data 'id=643&remark=0uoemv&createUserId=447&creator=v4lomr&createTime=2023-09-27 17:34:58&modifyUserId=362&modifyTime=2023-09-27 17:34:58&deleteFlag=0&ignoreWarning=true&nullFields=erj2fo,erj2fo&changeLogId=142&functionId=820&tagKey=61lfs4&tagName=gil.paucek&tagNameLocale=n4fc4g&tagColor=sme6ha&sceneNo=ezpjq1&enabled=true&sortIndex=1&extString1=2gcwuj&extString2=wg50ey&extString3=m5g44h&extString4=zfh229&extString5=stvohc&extString6=7y5nd3&extString7=3s3okl&extString8=8escm2&extString9=v6gejp&extString10=0ee4gw'

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "elm2hj",
      "defaultMsg": "e5ee4w",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "q78jl9",
      "defaultMsg": "nyhm32",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "6wfifz",
      "defaultMsg": "8c48fb",
      "context": {
        "object": "any object"
      }
    }
  ]
}

33.3.分页查询

Type: GET

Author: wangding

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

Description: 分页查询

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

current

int32

页码，默认为1

false

-

size

int32

页大小，默认为10

false

-

keyword

string

搜索关键字

false

-

idSet

object

ID

false

-

orders

array

排序

false

-

└─column

string

属性名称

false

-

└─asc

boolean

是否升序

false

-

id

int64

No comments found.

false

-

remark

string

No comments found.

false

-

createUserId

int64

No comments found.

false

-

loginUserId

int64

登录用户id 用于数据权限

false

-

createTimeStart

string

No comments found.

false

-

createTimeEnd

string

No comments found.

false

-

modifyUserId

int64

No comments found.

false

-

modifyTimeStart

string

No comments found.

false

-

modifyTimeEnd

string

No comments found.

false

-

dataPermissionFlag

boolean

No comments found.

false

-

functionId

int64

功能ID

false

-

functionName

string

功能名称

false

-

tagKey

string

标签KEY

false

-

tagName

string

标签名称

false

-

tagNameLocale

string

标签内容国际化

false

-

tagColor

string

标签颜色

false

-

sceneNo

string

场景编号

false

-

enabled

boolean

启用状态

false

-

sortIndex

int32

排序号

false

-

extString1

string

No comments found.

false

-

extString2

string

No comments found.

false

-

extString3

string

No comments found.

false

-

extString4

string

No comments found.

false

-

extString5

string

No comments found.

false

-

extString6

string

No comments found.

false

-

extString7

string

No comments found.

false

-

extString8

string

No comments found.

false

-

extString9

string

No comments found.

false

-

extString10

string

No comments found.

false

-

Request-example:

curl -X GET -H 'Authorization' -i /api/system/tag/paging?current=318&size=10&keyword=q47zel&column=y70yj2&asc=true&id=664&remark=olj7pg&createUserId=629&loginUserId=391&createTimeStart=2023-09-27 17:34:58&createTimeEnd=2023-09-27 17:34:58&modifyUserId=153&modifyTimeStart=2023-09-27 17:34:58&modifyTimeEnd=2023-09-27 17:34:58&dataPermissionFlag=true&functionId=255&functionName=gil.paucek&tagKey=46lnqr&tagName=gil.paucek&tagNameLocale=unf4yd&tagColor=d2lhnz&sceneNo=gfjgdo&enabled=true&sortIndex=1&extString1=willh6&extString2=tf9b7y&extString3=p2zo7p&extString4=el42as&extString5=72k9lm&extString6=j79yam&extString7=ex2ln5&extString8=amvk8y&extString9=mlx88p&extString10=g7p5n7&orders[0].asc=true&orders[0].column=wnzvrq

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "pormvf",
      "defaultMsg": "swhlmw",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "7eqbp4",
      "defaultMsg": "gmnki5",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "gnq4e5",
      "defaultMsg": "ydfjdo",
      "context": {
        "object": "any object"
      }
    }
  ]
}

33.4.列表查询

Type: GET

Author: wangding

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

Description: 列表查询

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

current

int32

页码，默认为1

false

-

size

int32

页大小，默认为10

false

-

keyword

string

搜索关键字

false

-

idSet

object

ID

false

-

orders

array

排序

false

-

└─column

string

属性名称

false

-

└─asc

boolean

是否升序

false

-

id

int64

No comments found.

false

-

remark

string

No comments found.

false

-

createUserId

int64

No comments found.

false

-

loginUserId

int64

登录用户id 用于数据权限

false

-

createTimeStart

string

No comments found.

false

-

createTimeEnd

string

No comments found.

false

-

modifyUserId

int64

No comments found.

false

-

modifyTimeStart

string

No comments found.

false

-

modifyTimeEnd

string

No comments found.

false

-

dataPermissionFlag

boolean

No comments found.

false

-

functionId

int64

功能ID

false

-

functionName

string

功能名称

false

-

tagKey

string

标签KEY

false

-

tagName

string

标签名称

false

-

tagNameLocale

string

标签内容国际化

false

-

tagColor

string

标签颜色

false

-

sceneNo

string

场景编号

false

-

enabled

boolean

启用状态

false

-

sortIndex

int32

排序号

false

-

extString1

string

No comments found.

false

-

extString2

string

No comments found.

false

-

extString3

string

No comments found.

false

-

extString4

string

No comments found.

false

-

extString5

string

No comments found.

false

-

extString6

string

No comments found.

false

-

extString7

string

No comments found.

false

-

extString8

string

No comments found.

false

-

extString9

string

No comments found.

false

-

extString10

string

No comments found.

false

-

Request-example:

curl -X GET -H 'Authorization' -i /api/system/tag/list?current=793&size=10&keyword=dz8nkd&column=xxcxf3&asc=true&id=696&remark=81djgu&createUserId=772&loginUserId=821&createTimeStart=2023-09-27 17:34:58&createTimeEnd=2023-09-27 17:34:58&modifyUserId=59&modifyTimeStart=2023-09-27 17:34:58&modifyTimeEnd=2023-09-27 17:34:58&dataPermissionFlag=true&functionId=242&functionName=gil.paucek&tagKey=vvbcf6&tagName=gil.paucek&tagNameLocale=mshayn&tagColor=f02w2a&sceneNo=q9rkma&enabled=true&sortIndex=1&extString1=gjo98t&extString2=59rqpu&extString3=3c2odn&extString4=84s7vx&extString5=pictcz&extString6=5rahpp&extString7=o20m03&extString8=9ln5ay&extString9=fyk3aa&extString10=t4g2qg&orders[0].asc=true&orders[0].column=jljjkf

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "jiez5r",
      "defaultMsg": "ixocic",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "5eqy6s",
      "defaultMsg": "t6n0rd",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "wwr2mx",
      "defaultMsg": "8rr2mc",
      "context": {
        "object": "any object"
      }
    }
  ]
}

33.5.物理删除

Type: DELETE

Author: wangding

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

Description: 物理删除

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

keys

array

主键,[array of int64]

false

-

Request-example:

curl -X DELETE -H 'Authorization' -i /api/system/tag?keys=fvo7p3&keys=fvo7p3

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "fl5kqy",
      "defaultMsg": "3vqrgn",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "bt921b",
      "defaultMsg": "2gy4r2",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "evtoq4",
      "defaultMsg": "m3dw8p",
      "context": {
        "object": "any object"
      }
    }
  ]
}

33.6.根据主键查询

Type: GET

Author: wangding

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

Description: 根据主键查询

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Path-parameters:

ParameterTypeDescriptionRequiredSince

key

int64

主键

true

-

Request-example:

curl -X GET -H 'Authorization' -i /api/system/tag/741

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "w358b7",
      "defaultMsg": "xqxz5i",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "0osxvz",
      "defaultMsg": "0xdgwp",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "rhl60n",
      "defaultMsg": "1svnno",
      "context": {
        "object": "any object"
      }
    }
  ]
}

33.7.清空消息提醒缓存

Type: GET

Author: wangding

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

Description: 清空消息提醒缓存

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Request-example:

curl -X GET -H 'Authorization' -i /api/system/tag/clearCache

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "luoogo",
      "defaultMsg": "x996ya",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "yma49s",
      "defaultMsg": "1i1j5z",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "pbgwdi",
      "defaultMsg": "w3phsv",
      "context": {
        "object": "any object"
      }
    }
  ]
}

34.

34.1.新建或修改

Type: POST

Author: zoey

Content-Type: application/json

Description: 新建或修改

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Body-parameters:

ParameterTypeDescriptionRequiredSince

id

int64

No comments found.

false

-

remark

string

No comments found.

false

-

createUserId

int64

No comments found.

false

-

creator

string

记录创建者

false

-

createTime

string

No comments found.

false

-

modifyUserId

int64

No comments found.

false

-

modifyTime

string

No comments found.

false

-

deleteFlag

int32

No comments found.

false

-

ignoreWarning

boolean

No comments found.

false

-

nullFields

array

No comments found.

false

-

changeLogId

int64

No comments found.

false

-

storageUrl

string

暂存url

false

-

storageContent

string

暂存内容

false

-

Request-example:

curl -X POST -H 'Content-Type: application/json' -H 'Authorization' -i /API_SYSTEM/storage/saveOne --data '{
  "id": 658,
  "remark": "vn8mwg",
  "createUserId": 123,
  "creator": "50x4om",
  "createTime": "2023-09-27 17:34:58",
  "modifyUserId": 929,
  "modifyTime": "2023-09-27 17:34:58",
  "deleteFlag": 0,
  "ignoreWarning": true,
  "nullFields": [
    "c3mnhj"
  ],
  "changeLogId": 922,
  "storageUrl": "www.lauretta-parisian.org",
  "storageContent": "w29uv6"
}'

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "hnd1vn",
      "defaultMsg": "schfm9",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "c17amd",
      "defaultMsg": "u1l3hl",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "7468es",
      "defaultMsg": "lw2rn1",
      "context": {
        "object": "any object"
      }
    }
  ]
}

34.2.局部字段更新

Type: POST

Author: zoey

Content-Type: application/json

Description: 局部字段更新

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Body-parameters:

ParameterTypeDescriptionRequiredSince

id

int64

No comments found.

false

-

remark

string

No comments found.

false

-

createUserId

int64

No comments found.

false

-

creator

string

记录创建者

false

-

createTime

string

No comments found.

false

-

modifyUserId

int64

No comments found.

false

-

modifyTime

string

No comments found.

false

-

deleteFlag

int32

No comments found.

false

-

ignoreWarning

boolean

No comments found.

false

-

nullFields

array

No comments found.

false

-

changeLogId

int64

No comments found.

false

-

storageUrl

string

暂存url

false

-

storageContent

string

暂存内容

false

-

Request-example:

curl -X POST -H 'Content-Type: application/json' -H 'Authorization' -i /API_SYSTEM/storage/dynamicUpdate --data '{
  "id": 786,
  "remark": "mgage5",
  "createUserId": 870,
  "creator": "xpwa94",
  "createTime": "2023-09-27 17:34:58",
  "modifyUserId": 298,
  "modifyTime": "2023-09-27 17:34:58",
  "deleteFlag": 0,
  "ignoreWarning": true,
  "nullFields": [
    "olqud1"
  ],
  "changeLogId": 155,
  "storageUrl": "www.lauretta-parisian.org",
  "storageContent": "buste0"
}'

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "ciror5",
      "defaultMsg": "182wiq",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "r3dwc0",
      "defaultMsg": "ljz8hl",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "cconwi",
      "defaultMsg": "vtofyd",
      "context": {
        "object": "any object"
      }
    }
  ]
}

34.3.列表查询不分页(默认列表)

Type: GET

Author: zoey

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

Description: 列表查询不分页(默认列表)

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

current

int32

页码，默认为1

false

-

size

int32

页大小，默认为10

false

-

keyword

string

搜索关键字

false

-

idSet

object

ID

false

-

orders

array

排序

false

-

└─column

string

属性名称

false

-

└─asc

boolean

是否升序

false

-

id

int64

No comments found.

false

-

remark

string

No comments found.

false

-

createUserId

int64

No comments found.

false

-

loginUserId

int64

登录用户id 用于数据权限

false

-

createTimeStart

string

No comments found.

false

-

createTimeEnd

string

No comments found.

false

-

modifyUserId

int64

No comments found.

false

-

modifyTimeStart

string

No comments found.

false

-

modifyTimeEnd

string

No comments found.

false

-

dataPermissionFlag

boolean

No comments found.

false

-

storageUrl

string

暂存url

false

-

storageContent

string

暂存内容

false

-

Request-example:

curl -X GET -H 'Authorization' -i /API_SYSTEM/storage/list?current=23&size=10&keyword=hthvc3&column=tzg62a&asc=true&id=875&remark=rvt7ar&createUserId=793&loginUserId=386&createTimeStart=2023-09-27 17:34:58&createTimeEnd=2023-09-27 17:34:58&modifyUserId=455&modifyTimeStart=2023-09-27 17:34:58&modifyTimeEnd=2023-09-27 17:34:58&dataPermissionFlag=true&storageUrl=www.lauretta-parisian.org&storageContent=q2dqfb&orders[0].asc=true&orders[0].column=9d94xf

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "3bu33r",
      "defaultMsg": "wy8f3b",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "iu7whj",
      "defaultMsg": "d97bsq",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "j016z3",
      "defaultMsg": "l5x347",
      "context": {
        "object": "any object"
      }
    }
  ]
}

34.4.分页查询

Type: GET

Author: zoey

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

Description: 分页查询

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

current

int32

页码，默认为1

false

-

size

int32

页大小，默认为10

false

-

keyword

string

搜索关键字

false

-

idSet

object

ID

false

-

orders

array

排序

false

-

└─column

string

属性名称

false

-

└─asc

boolean

是否升序

false

-

id

int64

No comments found.

false

-

remark

string

No comments found.

false

-

createUserId

int64

No comments found.

false

-

loginUserId

int64

登录用户id 用于数据权限

false

-

createTimeStart

string

No comments found.

false

-

createTimeEnd

string

No comments found.

false

-

modifyUserId

int64

No comments found.

false

-

modifyTimeStart

string

No comments found.

false

-

modifyTimeEnd

string

No comments found.

false

-

dataPermissionFlag

boolean

No comments found.

false

-

storageUrl

string

暂存url

false

-

storageContent

string

暂存内容

false

-

Request-example:

curl -X GET -H 'Authorization' -i /API_SYSTEM/storage/paging?current=595&size=10&keyword=slmzcy&column=qj7fe1&asc=true&id=550&remark=ba03h7&createUserId=630&loginUserId=357&createTimeStart=2023-09-27 17:34:58&createTimeEnd=2023-09-27 17:34:58&modifyUserId=334&modifyTimeStart=2023-09-27 17:34:58&modifyTimeEnd=2023-09-27 17:34:58&dataPermissionFlag=true&storageUrl=www.lauretta-parisian.org&storageContent=awdhyn&orders[0].asc=true&orders[0].column=sql6tq

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "mir35p",
      "defaultMsg": "gt12is",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "rpr4mz",
      "defaultMsg": "7xhewd",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "x71ylh",
      "defaultMsg": "rpkgnf",
      "context": {
        "object": "any object"
      }
    }
  ]
}

34.5.详情查询

Type: GET

Author: zoey

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

Description: 详情查询

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Path-parameters:

ParameterTypeDescriptionRequiredSince

id

int64

主键

true

-

Request-example:

curl -X GET -H 'Authorization' -i /API_SYSTEM/storage/detail/726

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "s1w1yw",
      "defaultMsg": "7f6ixh",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "501tzn",
      "defaultMsg": "d0rxor",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "a9m7an",
      "defaultMsg": "l6dtui",
      "context": {
        "object": "any object"
      }
    }
  ]
}

34.6.逻辑删除

Type: DELETE

Author: zoey

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

Description: 逻辑删除

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

storageIds

array

主键,[array of int64]

true

-

Request-example:

curl -X DELETE -H 'Authorization' -i /API_SYSTEM/storage/delete?storageIds=832,317

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "i2w2gp",
      "defaultMsg": "x47k3g",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "3eef4k",
      "defaultMsg": "07bw9k",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "mouivz",
      "defaultMsg": "fk9fvq",
      "context": {
        "object": "any object"
      }
    }
  ]
}

35.附件业务关系表

35.1.新增

Type: POST

Author: duwh

Content-Type: application/json

Description: 新增

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Body-parameters:

ParameterTypeDescriptionRequiredSince

id

int64

No comments found.

false

-

remark

string

No comments found.

false

-

createUserId

int64

No comments found.

false

-

creator

string

记录创建者

false

-

createTime

string

No comments found.

false

-

modifyUserId

int64

No comments found.

false

-

modifyTime

string

No comments found.

false

-

deleteFlag

int32

No comments found.

false

-

ignoreWarning

boolean

No comments found.

false

-

nullFields

array

No comments found.

false

-

changeLogId

int64

No comments found.

false

-

objType

string

业务类型：枚举：经营计划：OPER_PLAN OPER_PLAN_MAIN....

false

-

objId

int64

业务主键

false

-

fileCode

string

附件编码

false

-

fileName

string

自定义附件名称

false

-

ext1

string

拓展1

false

-

ext2

string

拓展2

false

-

ext3

string

拓展3

false

-

ext4

string

拓展4

false

-

ext5

string

拓展5

false

-

Request-example:

curl -X POST -H 'Content-Type: application/json' -H 'Authorization' -i /api/system/fmsFileRef --data '{
  "id": 381,
  "remark": "td2mg5",
  "createUserId": 133,
  "creator": "741bll",
  "createTime": "2023-09-27 17:34:58",
  "modifyUserId": 203,
  "modifyTime": "2023-09-27 17:34:58",
  "deleteFlag": 0,
  "ignoreWarning": true,
  "nullFields": [
    "dmacg9"
  ],
  "changeLogId": 446,
  "objType": "vhi7s4",
  "objId": 892,
  "fileCode": "88129",
  "fileName": "gil.paucek",
  "ext1": "nevfh1",
  "ext2": "yu2emo",
  "ext3": "j2tb1g",
  "ext4": "af4keh",
  "ext5": "q9yb47"
}'

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "t53gqx",
      "defaultMsg": "6ys3da",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "ywnrlt",
      "defaultMsg": "62dn8u",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "s7206c",
      "defaultMsg": "v9uga3",
      "context": {
        "object": "any object"
      }
    }
  ]
}

35.2.更新

Type: PUT

Author: duwh

Content-Type: application/json

Description: 更新

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Body-parameters:

ParameterTypeDescriptionRequiredSince

id

int64

No comments found.

false

-

remark

string

No comments found.

false

-

createUserId

int64

No comments found.

false

-

creator

string

记录创建者

false

-

createTime

string

No comments found.

false

-

modifyUserId

int64

No comments found.

false

-

modifyTime

string

No comments found.

false

-

deleteFlag

int32

No comments found.

false

-

ignoreWarning

boolean

No comments found.

false

-

nullFields

array

No comments found.

false

-

changeLogId

int64

No comments found.

false

-

objType

string

业务类型：枚举：经营计划：OPER_PLAN OPER_PLAN_MAIN....

false

-

objId

int64

业务主键

false

-

fileCode

string

附件编码

false

-

fileName

string

自定义附件名称

false

-

ext1

string

拓展1

false

-

ext2

string

拓展2

false

-

ext3

string

拓展3

false

-

ext4

string

拓展4

false

-

ext5

string

拓展5

false

-

Request-example:

curl -X PUT -H 'Content-Type: application/json' -H 'Authorization' -i /api/system/fmsFileRef --data '{
  "id": 376,
  "remark": "z7gmmf",
  "createUserId": 654,
  "creator": "nrf6yy",
  "createTime": "2023-09-27 17:34:58",
  "modifyUserId": 867,
  "modifyTime": "2023-09-27 17:34:58",
  "deleteFlag": 0,
  "ignoreWarning": true,
  "nullFields": [
    "blav0k"
  ],
  "changeLogId": 304,
  "objType": "r1nb52",
  "objId": 598,
  "fileCode": "88129",
  "fileName": "gil.paucek",
  "ext1": "90exu6",
  "ext2": "af5bfy",
  "ext3": "stkhjr",
  "ext4": "meirhj",
  "ext5": "1bwkm0"
}'

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "m5z2xt",
      "defaultMsg": "ftkdhg",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "cr03fa",
      "defaultMsg": "pqemld",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "99iqxx",
      "defaultMsg": "zu5yl8",
      "context": {
        "object": "any object"
      }
    }
  ]
}

35.3.主键查询

Type: GET

Author: duwh

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

Description: 主键查询

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Path-parameters:

ParameterTypeDescriptionRequiredSince

key

int64

关键

true

-

Request-example:

curl -X GET -H 'Authorization' -i /api/system/fmsFileRef/490

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "56b40d",
      "defaultMsg": "0ppdvs",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "4niyct",
      "defaultMsg": "jhn2ll",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "ghs7yn",
      "defaultMsg": "uwis5x",
      "context": {
        "object": "any object"
      }
    }
  ]
}

35.4.分页

Type: GET

Author: duwh

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

Description: 分页

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

current

int32

页码，默认为1

false

-

size

int32

页大小，默认为10

false

-

keyword

string

搜索关键字

false

-

idSet

object

ID

false

-

orders

array

排序

false

-

└─column

string

属性名称

false

-

└─asc

boolean

是否升序

false

-

id

int64

No comments found.

false

-

remark

string

No comments found.

false

-

createUserId

int64

No comments found.

false

-

loginUserId

int64

登录用户id 用于数据权限

false

-

createTimeStart

string

No comments found.

false

-

createTimeEnd

string

No comments found.

false

-

modifyUserId

int64

No comments found.

false

-

modifyTimeStart

string

No comments found.

false

-

modifyTimeEnd

string

No comments found.

false

-

dataPermissionFlag

boolean

No comments found.

false

-

objType

string

业务类型：枚举：经营计划：OPER_PLAN ....

false

-

objId

int64

业务主键

false

-

fileCode

string

附件编码

false

-

fileName

string

自定义附件名称

false

-

ext1

string

拓展1

false

-

ext2

string

拓展2

false

-

ext3

string

拓展3

false

-

ext4

string

拓展4

false

-

ext5

string

拓展5

false

-

Request-example:

curl -X GET -H 'Authorization' -i /api/system/fmsFileRef/paging?current=320&size=10&keyword=8hc2iq&column=mgydvi&asc=true&id=206&remark=x7xway&createUserId=219&loginUserId=681&createTimeStart=2023-09-27 17:34:58&createTimeEnd=2023-09-27 17:34:58&modifyUserId=519&modifyTimeStart=2023-09-27 17:34:58&modifyTimeEnd=2023-09-27 17:34:58&dataPermissionFlag=true&objType=h0clm5&objId=64&fileCode=88129&fileName=gil.paucek&ext1=lkqsw3&ext2=5rzl7t&ext3=d6jbap&ext4=oa3n3r&ext5=xpk1so&orders[0].asc=true&orders[0].column=b8b7f5

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "o5o9lg",
      "defaultMsg": "lsix4k",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "5h28ok",
      "defaultMsg": "nakub1",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "p77qea",
      "defaultMsg": "0jso1r",
      "context": {
        "object": "any object"
      }
    }
  ]
}

35.5.查询列表

Type: GET

Author: duwh

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

Description: 查询列表

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

current

int32

页码，默认为1

false

-

size

int32

页大小，默认为10

false

-

keyword

string

搜索关键字

false

-

idSet

object

ID

false

-

orders

array

排序

false

-

└─column

string

属性名称

false

-

└─asc

boolean

是否升序

false

-

id

int64

No comments found.

false

-

remark

string

No comments found.

false

-

createUserId

int64

No comments found.

false

-

loginUserId

int64

登录用户id 用于数据权限

false

-

createTimeStart

string

No comments found.

false

-

createTimeEnd

string

No comments found.

false

-

modifyUserId

int64

No comments found.

false

-

modifyTimeStart

string

No comments found.

false

-

modifyTimeEnd

string

No comments found.

false

-

dataPermissionFlag

boolean

No comments found.

false

-

objType

string

业务类型：枚举：经营计划：OPER_PLAN ....

false

-

objId

int64

业务主键

false

-

fileCode

string

附件编码

false

-

fileName

string

自定义附件名称

false

-

ext1

string

拓展1

false

-

ext2

string

拓展2

false

-

ext3

string

拓展3

false

-

ext4

string

拓展4

false

-

ext5

string

拓展5

false

-

Request-example:

curl -X GET -H 'Authorization' -i /api/system/fmsFileRef/list?current=844&size=10&keyword=tx4tt3&column=58gsuq&asc=true&id=191&remark=k14fgj&createUserId=426&loginUserId=678&createTimeStart=2023-09-27 17:34:58&createTimeEnd=2023-09-27 17:34:58&modifyUserId=389&modifyTimeStart=2023-09-27 17:34:58&modifyTimeEnd=2023-09-27 17:34:58&dataPermissionFlag=true&objType=hqiqql&objId=618&fileCode=88129&fileName=gil.paucek&ext1=2jrezf&ext2=x51di9&ext3=5cr95r&ext4=ttw4a4&ext5=9sxqu2&orders[0].asc=true&orders[0].column=sn0uj6

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "qto53j",
      "defaultMsg": "ic7eww",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "04vsqo",
      "defaultMsg": "iu6i42",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "44tknp",
      "defaultMsg": "ybgauh",
      "context": {
        "object": "any object"
      }
    }
  ]
}

35.6.删除

Type: DELETE

Author: duwh

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

Description: 删除

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

keys

array

主键id,[array of int64]

false

-

Request-example:

curl -X DELETE -H 'Authorization' -i /api/system/fmsFileRef/deleteSoft?keys=glkvlq&keys=glkvlq

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "b4oo3d",
      "defaultMsg": "4h6ptd",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "wb7d1p",
      "defaultMsg": "c0iz3f",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "gatzqk",
      "defaultMsg": "p7x1jl",
      "context": {
        "object": "any object"
      }
    }
  ]
}

35.7.根据fileCode删除

Type: DELETE

Author: duwh

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

Description: 根据fileCode删除

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

fileCode

string

fileCode

false

-

Request-example:

curl -X DELETE -H 'Authorization' -i /api/system/fmsFileRef/deleteSoftByFileCode?fileCode=88129

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "xjd4wo",
      "defaultMsg": "9m7hi6",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "g0kcbx",
      "defaultMsg": "nsx1nn",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "56khad",
      "defaultMsg": "vmw3he",
      "context": {
        "object": "any object"
      }
    }
  ]
}

36.系统功能关键行为项

36.1.新建

Type: POST

Author: wangding

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

Description: 新建

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

id

int64

No comments found.

false

-

remark

string

No comments found.

false

-

createUserId

int64

No comments found.

false

-

creator

string

记录创建者

false

-

createTime

string

No comments found.

false

-

modifyUserId

int64

No comments found.

false

-

modifyTime

string

No comments found.

false

-

deleteFlag

int32

No comments found.

false

-

ignoreWarning

boolean

No comments found.

false

-

nullFields

array

No comments found.

false

-

changeLogId

int64

No comments found.

false

-

functionId

int64

No comments found.

false

-

specialName

string

No comments found.

false

-

specialUrl

string

No comments found.

false

-

specialType

int32

No comments found.

false

-

specialCode

string

No comments found.

false

-

specialRoles

string

No comments found.

false

-

systemLevel

int32

No comments found.

false

-

Request-example:

curl -X POST -H 'Authorization' -i /API_SYSTEM/function/special/insert --data 'id=238&remark=6a6802&createUserId=239&creator=063112&createTime=2023-09-27 17:34:58&modifyUserId=736&modifyTime=2023-09-27 17:34:58&deleteFlag=0&ignoreWarning=true&nullFields=4ugopb,4ugopb&changeLogId=889&functionId=210&specialName=gil.paucek&specialUrl=www.lauretta-parisian.org&specialType=422&specialCode=88129&specialRoles=8aegpo&systemLevel=313'

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "1onhsd",
      "defaultMsg": "jjvurq",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "lcq02s",
      "defaultMsg": "n6dkq0",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "rhrduw",
      "defaultMsg": "ao21uq",
      "context": {
        "object": "any object"
      }
    }
  ]
}

36.2.全部修改

Type: PUT

Author: wangding

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

Description: 全部修改

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

id

int64

No comments found.

false

-

remark

string

No comments found.

false

-

createUserId

int64

No comments found.

false

-

creator

string

记录创建者

false

-

createTime

string

No comments found.

false

-

modifyUserId

int64

No comments found.

false

-

modifyTime

string

No comments found.

false

-

deleteFlag

int32

No comments found.

false

-

ignoreWarning

boolean

No comments found.

false

-

nullFields

array

No comments found.

false

-

changeLogId

int64

No comments found.

false

-

functionId

int64

No comments found.

false

-

specialName

string

No comments found.

false

-

specialUrl

string

No comments found.

false

-

specialType

int32

No comments found.

false

-

specialCode

string

No comments found.

false

-

specialRoles

string

No comments found.

false

-

systemLevel

int32

No comments found.

false

-

Request-example:

curl -X PUT -H 'Authorization' -i /API_SYSTEM/function/special/update --data 'id=121&remark=kabv1s&createUserId=449&creator=bcljcp&createTime=2023-09-27 17:34:58&modifyUserId=840&modifyTime=2023-09-27 17:34:58&deleteFlag=0&ignoreWarning=true&nullFields=0t9h7w,0t9h7w&changeLogId=135&functionId=209&specialName=gil.paucek&specialUrl=www.lauretta-parisian.org&specialType=973&specialCode=88129&specialRoles=i1fvgs&systemLevel=413'

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "4nar8w",
      "defaultMsg": "22xdlr",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "5831vl",
      "defaultMsg": "h4gcpc",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "ohnecc",
      "defaultMsg": "kttdtu",
      "context": {
        "object": "any object"
      }
    }
  ]
}

36.3.分页查询

Type: GET

Author: wangding

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

Description: 分页查询

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

current

int32

页码，默认为1

false

-

size

int32

页大小，默认为10

false

-

keyword

string

搜索关键字

false

-

idSet

object

ID

false

-

orders

array

排序

false

-

└─column

string

属性名称

false

-

└─asc

boolean

是否升序

false

-

id

int64

No comments found.

false

-

remark

string

No comments found.

false

-

createUserId

int64

No comments found.

false

-

loginUserId

int64

登录用户id 用于数据权限

false

-

createTimeStart

string

No comments found.

false

-

createTimeEnd

string

No comments found.

false

-

modifyUserId

int64

No comments found.

false

-

modifyTimeStart

string

No comments found.

false

-

modifyTimeEnd

string

No comments found.

false

-

dataPermissionFlag

boolean

No comments found.

false

-

functionId

int64

No comments found.

false

-

specialName

string

No comments found.

false

-

specialUrl

string

No comments found.

false

-

specialType

int32

No comments found.

false

-

specialCode

string

No comments found.

false

-

specialRoles

string

No comments found.

false

-

systemLevel

int32

No comments found.

false

-

Request-example:

curl -X GET -H 'Authorization' -i /API_SYSTEM/function/special/paging?current=270&size=10&keyword=4rm08b&column=1v8lvz&asc=true&id=675&remark=q1kva4&createUserId=432&loginUserId=80&createTimeStart=2023-09-27 17:34:58&createTimeEnd=2023-09-27 17:34:58&modifyUserId=926&modifyTimeStart=2023-09-27 17:34:58&modifyTimeEnd=2023-09-27 17:34:58&dataPermissionFlag=true&functionId=442&specialName=gil.paucek&specialUrl=www.lauretta-parisian.org&specialType=939&specialCode=88129&specialRoles=y1ei9a&systemLevel=128&orders[0].column=rrhdvh&orders[0].asc=true

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "f3znqs",
      "defaultMsg": "5y8bf1",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "p4yfvo",
      "defaultMsg": "esmxlq",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "wlyonw",
      "defaultMsg": "e0uy10",
      "context": {
        "object": "any object"
      }
    }
  ]
}

36.4.列表查询

Type: GET

Author: wangding

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

Description: 列表查询

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

current

int32

页码，默认为1

false

-

size

int32

页大小，默认为10

false

-

keyword

string

搜索关键字

false

-

idSet

object

ID

false

-

orders

array

排序

false

-

└─column

string

属性名称

false

-

└─asc

boolean

是否升序

false

-

id

int64

No comments found.

false

-

remark

string

No comments found.

false

-

createUserId

int64

No comments found.

false

-

loginUserId

int64

登录用户id 用于数据权限

false

-

createTimeStart

string

No comments found.

false

-

createTimeEnd

string

No comments found.

false

-

modifyUserId

int64

No comments found.

false

-

modifyTimeStart

string

No comments found.

false

-

modifyTimeEnd

string

No comments found.

false

-

dataPermissionFlag

boolean

No comments found.

false

-

functionId

int64

No comments found.

false

-

specialName

string

No comments found.

false

-

specialUrl

string

No comments found.

false

-

specialType

int32

No comments found.

false

-

specialCode

string

No comments found.

false

-

specialRoles

string

No comments found.

false

-

systemLevel

int32

No comments found.

false

-

Request-example:

curl -X GET -H 'Authorization' -i /API_SYSTEM/function/special/list?current=614&size=10&keyword=qjity9&column=w9pqdr&asc=true&id=487&remark=fx1mqe&createUserId=227&loginUserId=184&createTimeStart=2023-09-27 17:34:58&createTimeEnd=2023-09-27 17:34:58&modifyUserId=720&modifyTimeStart=2023-09-27 17:34:58&modifyTimeEnd=2023-09-27 17:34:58&dataPermissionFlag=true&functionId=377&specialName=gil.paucek&specialUrl=www.lauretta-parisian.org&specialType=626&specialCode=88129&specialRoles=mordg6&systemLevel=969&orders[0].asc=true&orders[0].column=0ol59b

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "q90axd",
      "defaultMsg": "1yx7oz",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "7fgcp6",
      "defaultMsg": "qqe8m1",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "ll4ica",
      "defaultMsg": "a7hdw7",
      "context": {
        "object": "any object"
      }
    }
  ]
}

36.5.物理删除

Type: DELETE

Author: wangding

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

Description: 物理删除

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

keys

array

主键,[array of int64]

false

-

Request-example:

curl -X DELETE -H 'Authorization' -i /API_SYSTEM/function/special/delete?keys=9cbw5z&keys=9cbw5z

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "c2gsj8",
      "defaultMsg": "xug71i",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "13yivg",
      "defaultMsg": "n97k2v",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "vrn27k",
      "defaultMsg": "or0a2q",
      "context": {
        "object": "any object"
      }
    }
  ]
}

36.6.根据主键查询

Type: GET

Author: wangding

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

Description: 根据主键查询

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Path-parameters:

ParameterTypeDescriptionRequiredSince

key

int64

主键

true

-

Request-example:

curl -X GET -H 'Authorization' -i /API_SYSTEM/function/Special/683

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "alt2e1",
      "defaultMsg": "082ie8",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "21wm1m",
      "defaultMsg": "igigdr",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "06ic5x",
      "defaultMsg": "7y636j",
      "context": {
        "object": "any object"
      }
    }
  ]
}

37.系统设置项管理

37.1.新建

Type: POST

Author: wangding

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

Description: 新建

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

id

int64

No comments found.

false

-

remark

string

No comments found.

false

-

createUserId

int64

No comments found.

false

-

creator

string

记录创建者

false

-

createTime

string

No comments found.

false

-

modifyUserId

int64

No comments found.

false

-

modifyTime

string

No comments found.

false

-

deleteFlag

int32

No comments found.

false

-

ignoreWarning

boolean

No comments found.

false

-

nullFields

array

No comments found.

false

-

changeLogId

int64

No comments found.

false

-

functionId

int64

No comments found.

false

-

settingKey

string

No comments found.

false

-

settingName

string

No comments found.

false

-

settingValue

string

No comments found.

false

-

systemModule

string

No comments found.

false

-

allowChange

string

No comments found.

false

-

extString1

string

No comments found.

false

-

extString2

string

No comments found.

false

-

extString3

string

No comments found.

false

-

extString4

string

No comments found.

false

-

extString5

string

No comments found.

false

-

extString6

string

No comments found.

false

-

extString7

string

No comments found.

false

-

extString8

string

No comments found.

false

-

extString9

string

No comments found.

false

-

extString10

string

No comments found.

false

-

Request-example:

curl -X POST -H 'Authorization' -i /API_SYSTEM/systemSetting --data 'id=36&remark=wa3mzk&createUserId=804&creator=xcbn7i&createTime=2023-09-27 17:34:58&modifyUserId=830&modifyTime=2023-09-27 17:34:58&deleteFlag=0&ignoreWarning=true&nullFields=cm7t9r,cm7t9r&changeLogId=601&functionId=108&settingKey=p2q7es&settingName=gil.paucek&settingValue=gjdd7v&systemModule=es9cwa&allowChange=dz42tn&extString1=lgat7x&extString2=4bo3lj&extString3=xfhr97&extString4=jrlnb7&extString5=kf7zur&extString6=d1dn4h&extString7=72z5bn&extString8=rguhwm&extString9=yx0hj6&extString10=gpyyoz'

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "bcdg3k",
      "defaultMsg": "l6g4j9",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "59a3tv",
      "defaultMsg": "y2vq6m",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "oc0ni4",
      "defaultMsg": "y25qtj",
      "context": {
        "object": "any object"
      }
    }
  ]
}

37.2.分页查询

Type: GET

Author: wangding

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

Description: 分页查询

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

current

int32

页码，默认为1

false

-

size

int32

页大小，默认为10

false

-

keyword

string

搜索关键字

false

-

idSet

object

ID

false

-

orders

array

排序

false

-

└─column

string

属性名称

false

-

└─asc

boolean

是否升序

false

-

id

int64

No comments found.

false

-

remark

string

No comments found.

false

-

createUserId

int64

No comments found.

false

-

loginUserId

int64

登录用户id 用于数据权限

false

-

createTimeStart

string

No comments found.

false

-

createTimeEnd

string

No comments found.

false

-

modifyUserId

int64

No comments found.

false

-

modifyTimeStart

string

No comments found.

false

-

modifyTimeEnd

string

No comments found.

false

-

dataPermissionFlag

boolean

No comments found.

false

-

functionId

int64

No comments found.

false

-

settingKey

string

No comments found.

false

-

settingName

string

No comments found.

false

-

settingValue

string

No comments found.

false

-

systemModule

string

No comments found.

false

-

allowChange

string

No comments found.

false

-

extString1

string

No comments found.

false

-

extString2

string

No comments found.

false

-

extString3

string

No comments found.

false

-

extString4

string

No comments found.

false

-

extString5

string

No comments found.

false

-

extString6

string

No comments found.

false

-

extString7

string

No comments found.

false

-

extString8

string

No comments found.

false

-

extString9

string

No comments found.

false

-

extString10

string

No comments found.

false

-

Request-example:

curl -X GET -H 'Authorization' -i /API_SYSTEM/systemSetting/paging?current=576&size=10&keyword=5l1zu1&column=veq4mn&asc=true&id=908&remark=9gpaky&createUserId=543&loginUserId=518&createTimeStart=2023-09-27 17:34:58&createTimeEnd=2023-09-27 17:34:58&modifyUserId=352&modifyTimeStart=2023-09-27 17:34:58&modifyTimeEnd=2023-09-27 17:34:58&dataPermissionFlag=true&functionId=323&settingKey=qatnma&settingName=gil.paucek&settingValue=yxck0n&systemModule=bheido&allowChange=32vecg&extString1=my1he0&extString2=8e2a7e&extString3=45k2de&extString4=8kuoij&extString5=gjzs2w&extString6=vit310&extString7=srjnt0&extString8=xwp3dd&extString9=grljsz&extString10=qblag2&orders[0].asc=true&orders[0].column=hsmdgh

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "xe6f36",
      "defaultMsg": "c9nvor",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "odfznb",
      "defaultMsg": "16b0ox",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "22tmn1",
      "defaultMsg": "ozhyrp",
      "context": {
        "object": "any object"
      }
    }
  ]
}

37.3.列表查询

Type: GET

Author: wangding

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

Description: 列表查询

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

current

int32

页码，默认为1

false

-

size

int32

页大小，默认为10

false

-

keyword

string

搜索关键字

false

-

idSet

object

ID

false

-

orders

array

排序

false

-

└─column

string

属性名称

false

-

└─asc

boolean

是否升序

false

-

id

int64

No comments found.

false

-

remark

string

No comments found.

false

-

createUserId

int64

No comments found.

false

-

loginUserId

int64

登录用户id 用于数据权限

false

-

createTimeStart

string

No comments found.

false

-

createTimeEnd

string

No comments found.

false

-

modifyUserId

int64

No comments found.

false

-

modifyTimeStart

string

No comments found.

false

-

modifyTimeEnd

string

No comments found.

false

-

dataPermissionFlag

boolean

No comments found.

false

-

functionId

int64

No comments found.

false

-

settingKey

string

No comments found.

false

-

settingName

string

No comments found.

false

-

settingValue

string

No comments found.

false

-

systemModule

string

No comments found.

false

-

allowChange

string

No comments found.

false

-

extString1

string

No comments found.

false

-

extString2

string

No comments found.

false

-

extString3

string

No comments found.

false

-

extString4

string

No comments found.

false

-

extString5

string

No comments found.

false

-

extString6

string

No comments found.

false

-

extString7

string

No comments found.

false

-

extString8

string

No comments found.

false

-

extString9

string

No comments found.

false

-

extString10

string

No comments found.

false

-

Request-example:

curl -X GET -H 'Authorization' -i /API_SYSTEM/systemSetting/list?current=450&size=10&keyword=unu4qj&column=m3ajjj&asc=true&id=794&remark=tix7cq&createUserId=889&loginUserId=303&createTimeStart=2023-09-27 17:34:58&createTimeEnd=2023-09-27 17:34:58&modifyUserId=141&modifyTimeStart=2023-09-27 17:34:58&modifyTimeEnd=2023-09-27 17:34:58&dataPermissionFlag=true&functionId=150&settingKey=v6sis3&settingName=gil.paucek&settingValue=7srs3o&systemModule=4d7jse&allowChange=sfjtfh&extString1=587kib&extString2=lwst2a&extString3=6wjhfu&extString4=7u7g1d&extString5=utszr4&extString6=yddj9v&extString7=ic5qka&extString8=7bmlyk&extString9=nngiy7&extString10=wzu9rv&orders[0].asc=true&orders[0].column=8ofdjz

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "gchlfs",
      "defaultMsg": "zy83nk",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "sp4qw5",
      "defaultMsg": "ryo8qa",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "on1zbl",
      "defaultMsg": "4illdt",
      "context": {
        "object": "any object"
      }
    }
  ]
}

37.4.物理删除

Type: DELETE

Author: wangding

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

Description: 物理删除

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

keys

array

主键,[array of int64]

false

-

Request-example:

curl -X DELETE -H 'Authorization' -i /API_SYSTEM/systemSetting?keys=u93wae&keys=u93wae

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "6eocgl",
      "defaultMsg": "u8wl3r",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "ev2hqi",
      "defaultMsg": "6ml308",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "kno0ar",
      "defaultMsg": "rqnbcw",
      "context": {
        "object": "any object"
      }
    }
  ]
}

37.5.全部修改

Type: PUT

Author: wangding

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

Description: 全部修改

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

id

int64

No comments found.

false

-

remark

string

No comments found.

false

-

createUserId

int64

No comments found.

false

-

creator

string

记录创建者

false

-

createTime

string

No comments found.

false

-

modifyUserId

int64

No comments found.

false

-

modifyTime

string

No comments found.

false

-

deleteFlag

int32

No comments found.

false

-

ignoreWarning

boolean

No comments found.

false

-

nullFields

array

No comments found.

false

-

changeLogId

int64

No comments found.

false

-

functionId

int64

No comments found.

false

-

settingKey

string

No comments found.

false

-

settingName

string

No comments found.

false

-

settingValue

string

No comments found.

false

-

systemModule

string

No comments found.

false

-

allowChange

string

No comments found.

false

-

extString1

string

No comments found.

false

-

extString2

string

No comments found.

false

-

extString3

string

No comments found.

false

-

extString4

string

No comments found.

false

-

extString5

string

No comments found.

false

-

extString6

string

No comments found.

false

-

extString7

string

No comments found.

false

-

extString8

string

No comments found.

false

-

extString9

string

No comments found.

false

-

extString10

string

No comments found.

false

-

Request-example:

curl -X PUT -H 'Authorization' -i /API_SYSTEM/systemSetting --data 'id=504&remark=d4jpdr&createUserId=984&creator=ahtfa1&createTime=2023-09-27 17:34:58&modifyUserId=965&modifyTime=2023-09-27 17:34:58&deleteFlag=0&ignoreWarning=true&nullFields=viq85r,viq85r&changeLogId=170&functionId=400&settingKey=bi9lie&settingName=gil.paucek&settingValue=kn3f02&systemModule=8b52zx&allowChange=s7mvjn&extString1=heqyx8&extString2=2kt4s0&extString3=blj6sm&extString4=zdpcdn&extString5=b3xfmj&extString6=ae2dqk&extString7=bdy5zf&extString8=g72boi&extString9=ufcmxw&extString10=uu5gkq'

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "yye8bl",
      "defaultMsg": "xdanve",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "evge0a",
      "defaultMsg": "8aa76s",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "9i1fpd",
      "defaultMsg": "2njint",
      "context": {
        "object": "any object"
      }
    }
  ]
}

37.6.根据主键查询

Type: GET

Author: wangding

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

Description: 根据主键查询

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Path-parameters:

ParameterTypeDescriptionRequiredSince

key

int64

主键

true

-

Request-example:

curl -X GET -H 'Authorization' -i /API_SYSTEM/systemSetting/340

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "4kz3ea",
      "defaultMsg": "0c9akj",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "jgfhl9",
      "defaultMsg": "jepgeu",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "42nk37",
      "defaultMsg": "atng2y",
      "context": {
        "object": "any object"
      }
    }
  ]
}

37.7.通过KEY获取系统设置

Type: GET

Author: wangding

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

Description: 通过KEY获取系统设置

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Path-parameters:

ParameterTypeDescriptionRequiredSince

key

string

下拉选择key

true

-

Request-example:

curl -X GET -H 'Authorization' -i /API_SYSTEM/systemSetting/byKey/ldvjip

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "ei9qxf",
      "defaultMsg": "kwkuky",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "n0ks73",
      "defaultMsg": "uno59x",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "zaft0c",
      "defaultMsg": "hvjep6",
      "context": {
        "object": "any object"
      }
    }
  ]
}

37.8.清空消息提醒缓存

Type: GET

Author: wangding

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

Description: 清空消息提醒缓存

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Request-example:

curl -X GET -H 'Authorization' -i /API_SYSTEM/systemSetting/clearCache

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "ef5if0",
      "defaultMsg": "au9p85",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "m9bde6",
      "defaultMsg": "6uzgc7",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "yefjo2",
      "defaultMsg": "sjxulc",
      "context": {
        "object": "any object"
      }
    }
  ]
}

38.系统功能处理-帮助管理

38.1.新建

Type: POST

Author: Lemon

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

Description: 新建

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

id

int64

No comments found.

false

-

remark

string

No comments found.

false

-

createUserId

int64

No comments found.

false

-

creator

string

记录创建者

false

-

createTime

string

No comments found.

false

-

modifyUserId

int64

No comments found.

false

-

modifyTime

string

No comments found.

false

-

deleteFlag

int32

No comments found.

false

-

ignoreWarning

boolean

No comments found.

false

-

nullFields

array

No comments found.

false

-

changeLogId

int64

No comments found.

false

-

helpNo

string

No comments found.

false

-

helpTitle

string

No comments found.

false

-

articleUrl

string

No comments found.

false

-

linkUrl

string

No comments found.

false

-

Request-example:

curl -X POST -H 'Authorization' -i /API_SYSTEM/help/insert --data 'id=50&remark=f8sg1q&createUserId=548&creator=9inokb&createTime=2023-09-27 17:34:58&modifyUserId=566&modifyTime=2023-09-27 17:34:58&deleteFlag=0&ignoreWarning=true&nullFields=7tfuia,7tfuia&changeLogId=146&helpNo=iudlh7&helpTitle=195fx7&articleUrl=www.lauretta-parisian.org&linkUrl=www.lauretta-parisian.org'

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "o27t64",
      "defaultMsg": "lgfuzu",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "uzdn5n",
      "defaultMsg": "iiqfy4",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "n80viv",
      "defaultMsg": "1c7mav",
      "context": {
        "object": "any object"
      }
    }
  ]
}

38.2.全部修改

Type: PUT

Author: Lemon

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

Description: 全部修改

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

id

int64

No comments found.

false

-

remark

string

No comments found.

false

-

createUserId

int64

No comments found.

false

-

creator

string

记录创建者

false

-

createTime

string

No comments found.

false

-

modifyUserId

int64

No comments found.

false

-

modifyTime

string

No comments found.

false

-

deleteFlag

int32

No comments found.

false

-

ignoreWarning

boolean

No comments found.

false

-

nullFields

array

No comments found.

false

-

changeLogId

int64

No comments found.

false

-

helpNo

string

No comments found.

false

-

helpTitle

string

No comments found.

false

-

articleUrl

string

No comments found.

false

-

linkUrl

string

No comments found.

false

-

Request-example:

curl -X PUT -H 'Authorization' -i /API_SYSTEM/help/update --data 'id=631&remark=8qg0vz&createUserId=612&creator=hdum1m&createTime=2023-09-27 17:34:58&modifyUserId=893&modifyTime=2023-09-27 17:34:58&deleteFlag=0&ignoreWarning=true&nullFields=4s25nu,4s25nu&changeLogId=394&helpNo=zzm1kq&helpTitle=bnrlbq&articleUrl=www.lauretta-parisian.org&linkUrl=www.lauretta-parisian.org'

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "qe0c2u",
      "defaultMsg": "q15bbt",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "87vhko",
      "defaultMsg": "hlnxit",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "zntr4y",
      "defaultMsg": "zisvhq",
      "context": {
        "object": "any object"
      }
    }
  ]
}

38.3.逻辑删除

Type: DELETE

Author: Lemon

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

Description: 逻辑删除

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

keys

array

主键,[array of int64]

false

-

Request-example:

curl -X DELETE -H 'Authorization' -i /API_SYSTEM/help/delete?keys=3ru0m5&keys=3ru0m5

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "lcwwfv",
      "defaultMsg": "ir1ii8",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "s1nyex",
      "defaultMsg": "4ww3bg",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "qb803i",
      "defaultMsg": "kbn6pi",
      "context": {
        "object": "any object"
      }
    }
  ]
}

38.4.

Type: GET

Author: Lemon

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

Description: 

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Path-parameters:

ParameterTypeDescriptionRequiredSince

key

int64

No comments found.

true

-

Request-example:

curl -X GET -H 'Authorization' -i /API_SYSTEM/help/61

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "p4adqo",
      "defaultMsg": "bz3bh5",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "gtlsji",
      "defaultMsg": "1z93rw",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "xr174k",
      "defaultMsg": "zej9sq",
      "context": {
        "object": "any object"
      }
    }
  ]
}

38.5.

Type: GET

Author: Lemon

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

Description: 

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

current

int32

页码，默认为1

false

-

size

int32

页大小，默认为10

false

-

keyword

string

搜索关键字

false

-

idSet

object

ID

false

-

orders

array

排序

false

-

└─column

string

属性名称

false

-

└─asc

boolean

是否升序

false

-

id

int64

No comments found.

false

-

remark

string

No comments found.

false

-

createUserId

int64

No comments found.

false

-

loginUserId

int64

登录用户id 用于数据权限

false

-

createTimeStart

string

No comments found.

false

-

createTimeEnd

string

No comments found.

false

-

modifyUserId

int64

No comments found.

false

-

modifyTimeStart

string

No comments found.

false

-

modifyTimeEnd

string

No comments found.

false

-

dataPermissionFlag

boolean

No comments found.

false

-

helpNo

string

No comments found.

false

-

helpTitle

string

No comments found.

false

-

Request-example:

curl -X GET -H 'Authorization' -i /API_SYSTEM/help/paging?current=980&size=10&keyword=x760t3&column=pisl8d&asc=true&id=680&remark=tsr4po&createUserId=326&loginUserId=933&createTimeStart=2023-09-27 17:34:58&createTimeEnd=2023-09-27 17:34:58&modifyUserId=172&modifyTimeStart=2023-09-27 17:34:58&modifyTimeEnd=2023-09-27 17:34:58&dataPermissionFlag=true&helpNo=npvykq&helpTitle=ft4lyc&orders[0].column=xx1308&orders[0].asc=true

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "z091nn",
      "defaultMsg": "8gqhnt",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "u95tk2",
      "defaultMsg": "2ebcqi",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "b6lk64",
      "defaultMsg": "5brxnt",
      "context": {
        "object": "any object"
      }
    }
  ]
}

38.6.

Type: GET

Author: Lemon

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

Description: 

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

current

int32

页码，默认为1

false

-

size

int32

页大小，默认为10

false

-

keyword

string

搜索关键字

false

-

idSet

object

ID

false

-

orders

array

排序

false

-

└─column

string

属性名称

false

-

└─asc

boolean

是否升序

false

-

id

int64

No comments found.

false

-

remark

string

No comments found.

false

-

createUserId

int64

No comments found.

false

-

loginUserId

int64

登录用户id 用于数据权限

false

-

createTimeStart

string

No comments found.

false

-

createTimeEnd

string

No comments found.

false

-

modifyUserId

int64

No comments found.

false

-

modifyTimeStart

string

No comments found.

false

-

modifyTimeEnd

string

No comments found.

false

-

dataPermissionFlag

boolean

No comments found.

false

-

helpNo

string

No comments found.

false

-

helpTitle

string

No comments found.

false

-

Request-example:

curl -X GET -H 'Authorization' -i /API_SYSTEM/help/queryList?current=709&size=10&keyword=bptgt5&column=manofc&asc=true&id=810&remark=j671pa&createUserId=539&loginUserId=885&createTimeStart=2023-09-27 17:34:58&createTimeEnd=2023-09-27 17:34:58&modifyUserId=459&modifyTimeStart=2023-09-27 17:34:58&modifyTimeEnd=2023-09-27 17:34:58&dataPermissionFlag=true&helpNo=y5jcen&helpTitle=f38bmg&orders[0].column=4kuq7t&orders[0].asc=true

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "hi0ync",
      "defaultMsg": "g95o3d",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "xjhdgx",
      "defaultMsg": "ydl97l",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "fxohpq",
      "defaultMsg": "gx1j86",
      "context": {
        "object": "any object"
      }
    }
  ]
}

39.人力资源管理

39.1.分页查询

Type: GET

Author: wangding

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

Description: 分页查询

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

current

int32

页码，默认为1

false

-

size

int32

页大小，默认为10

false

-

keyword

string

搜索关键字

false

-

idSet

object

ID

false

-

orders

array

排序

false

-

└─column

string

属性名称

false

-

└─asc

boolean

是否升序

false

-

id

int64

No comments found.

false

-

remark

string

No comments found.

false

-

createUserId

int64

No comments found.

false

-

loginUserId

int64

登录用户id 用于数据权限

false

-

createTimeStart

string

No comments found.

false

-

createTimeEnd

string

No comments found.

false

-

modifyUserId

int64

No comments found.

false

-

modifyTimeStart

string

No comments found.

false

-

modifyTimeEnd

string

No comments found.

false

-

dataPermissionFlag

boolean

No comments found.

false

-

sysType

string

类型

false

-

sysWork

string

工种

false

-

sysLevel

string

等级

false

-

downloadType

string

导出类型 model:模板，data:数据

false

-

Request-example:

curl -X GET -H 'Authorization' -i /api/system/workType/paging?current=360&size=10&keyword=5prdky&column=trwiwh&asc=true&id=673&remark=7njidg&createUserId=563&loginUserId=0&createTimeStart=2023-09-27 17:34:58&createTimeEnd=2023-09-27 17:34:58&modifyUserId=728&modifyTimeStart=2023-09-27 17:34:58&modifyTimeEnd=2023-09-27 17:34:58&dataPermissionFlag=true&sysType=7f1805&sysWork=he48ux&sysLevel=ge1yxe&downloadType=e3muyw&orders[0].column=hb7cu7&orders[0].asc=true

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "yvju9e",
      "defaultMsg": "uud8st",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "2t50n6",
      "defaultMsg": "p0xtos",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "viqmbw",
      "defaultMsg": "4lvq2f",
      "context": {
        "object": "any object"
      }
    }
  ]
}

39.2.列表查询

Type: GET

Author: wangding

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

Description: 列表查询

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Request-example:

curl -X GET -H 'Authorization' -i /api/system/workType/list

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "3fem7o",
      "defaultMsg": "g33cco",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "ec6m6z",
      "defaultMsg": "7en8ui",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "dyqflt",
      "defaultMsg": "f5zllv",
      "context": {
        "object": "any object"
      }
    }
  ]
}

39.3.物理删除

Type: DELETE

Author: wangding

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

Description: 物理删除

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

keys

array

主键,[array of int64]

false

-

Request-example:

curl -X DELETE -H 'Authorization' -i /api/system/workType?keys=5jai3c&keys=5jai3c

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "7hkgzz",
      "defaultMsg": "s8tv7q",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "ii4bba",
      "defaultMsg": "3ubp2q",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "egzavq",
      "defaultMsg": "yxt5b9",
      "context": {
        "object": "any object"
      }
    }
  ]
}

39.4.修改

Type: PUT

Author: wangding

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

Description: 修改

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

key

int64

No comments found.

false

-

sysType

string

No comments found.

false

-

sysWork

string

No comments found.

false

-

sysLevel

string

No comments found.

false

-

unitPrice

number

No comments found.

false

-

Request-example:

curl -X PUT -H 'Authorization' -i /api/system/workType --data 'key=924&sysType=9oes65&sysWork=etkb3o&sysLevel=v59gae&unitPrice=354'

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "v8kopl",
      "defaultMsg": "yb7crb",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "zkxsiv",
      "defaultMsg": "8r6re4",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "0cz949",
      "defaultMsg": "7otzee",
      "context": {
        "object": "any object"
      }
    }
  ]
}

39.5.批量导出excel

Type: GET

Author: wangding

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

Description: 批量导出excel

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

current

int32

页码，默认为1

false

-

size

int32

页大小，默认为10

false

-

keyword

string

搜索关键字

false

-

idSet

object

ID

false

-

orders

array

排序

false

-

└─column

string

属性名称

false

-

└─asc

boolean

是否升序

false

-

id

int64

No comments found.

false

-

remark

string

No comments found.

false

-

createUserId

int64

No comments found.

false

-

loginUserId

int64

登录用户id 用于数据权限

false

-

createTimeStart

string

No comments found.

false

-

createTimeEnd

string

No comments found.

false

-

modifyUserId

int64

No comments found.

false

-

modifyTimeStart

string

No comments found.

false

-

modifyTimeEnd

string

No comments found.

false

-

dataPermissionFlag

boolean

No comments found.

false

-

sysType

string

类型

false

-

sysWork

string

工种

false

-

sysLevel

string

等级

false

-

downloadType

string

导出类型 model:模板，data:数据

false

-

Request-example:

curl -X GET -H 'Authorization' -i /api/system/workType/batchExport?current=989&size=10&keyword=sw25oa&column=egg445&asc=true&id=193&remark=abug9s&createUserId=118&loginUserId=983&createTimeStart=2023-09-27 17:34:58&createTimeEnd=2023-09-27 17:34:58&modifyUserId=528&modifyTimeStart=2023-09-27 17:34:58&modifyTimeEnd=2023-09-27 17:34:58&dataPermissionFlag=true&sysType=h5zejr&sysWork=v7jgz6&sysLevel=9s19yp&downloadType=5ltv28&orders[0].asc=true&orders[0].column=sj5o3y

Response-example:

Return void.

39.6.批量导入excel

Type: POST

Author: wangding

Content-Type: multipart/form-data

Description: 批量导入excel

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

file

file

No comments found.

false

-

Request-example:

curl -X POST -H 'Content-Type: multipart/form-data' -H 'Authorization' -F 'file=' -i /api/system/workType/batchImport

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "a62wrr",
      "defaultMsg": "lg5jcd",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "zrotad",
      "defaultMsg": "t0l04b",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "kvdqth",
      "defaultMsg": "l3qhdh",
      "context": {
        "object": "any object"
      }
    }
  ]
}

40.系统功能处理-问题反馈处理过程

40.1.新建

Type: POST

Author: Lemon

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

Description: 新建

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

id

int64

No comments found.

false

-

remark

string

No comments found.

false

-

createUserId

int64

No comments found.

false

-

creator

string

记录创建者

false

-

createTime

string

No comments found.

false

-

modifyUserId

int64

No comments found.

false

-

modifyTime

string

No comments found.

false

-

deleteFlag

int32

No comments found.

false

-

ignoreWarning

boolean

No comments found.

false

-

nullFields

array

No comments found.

false

-

changeLogId

int64

No comments found.

false

-

feedbackId

int64

No comments found.

false

-

content

string

No comments found.

false

-

processType

string

No comments found.

false

-

fileCodes

string

No comments found.

false

-

pageFlag

int32

No comments found.

false

-

Request-example:

curl -X POST -H 'Authorization' -i /API_SYSTEM/problemFeedbackProcess/insert --data 'id=623&remark=n6brxo&createUserId=768&creator=p59rbx&createTime=2023-09-27 17:34:58&modifyUserId=364&modifyTime=2023-09-27 17:34:58&deleteFlag=0&ignoreWarning=true&nullFields=iu4s25,iu4s25&changeLogId=581&feedbackId=207&content=rtiibv&processType=lj6nl1&fileCodes=15k0cj&pageFlag=0'

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "qsk1j6",
      "defaultMsg": "5t25jf",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "v0g95v",
      "defaultMsg": "2pt5js",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "kljcaq",
      "defaultMsg": "pywtfc",
      "context": {
        "object": "any object"
      }
    }
  ]
}

41.系统功能管理

41.1.新建

Type: POST

Author: wangding

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

Description: 新建

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

id

int64

No comments found.

false

-

remark

string

No comments found.

false

-

createUserId

int64

No comments found.

false

-

creator

string

记录创建者

false

-

createTime

string

No comments found.

false

-

modifyUserId

int64

No comments found.

false

-

modifyTime

string

No comments found.

false

-

deleteFlag

int32

No comments found.

false

-

ignoreWarning

boolean

No comments found.

false

-

nullFields

array

No comments found.

false

-

changeLogId

int64

No comments found.

false

-

parentId

int64

No comments found.

false

-

functionCode

string

No comments found.

false

-

functionIndent

string

No comments found.

false

-

functionName

string

No comments found.

false

-

functionVersion

string

No comments found.

false

-

functionStatus

string

No comments found.

false

-

extString1

string

No comments found.

false

-

extString2

string

No comments found.

false

-

extString3

string

No comments found.

false

-

extString4

string

No comments found.

false

-

extString5

string

No comments found.

false

-

extString6

string

No comments found.

false

-

extString7

string

No comments found.

false

-

extString8

string

No comments found.

false

-

extString9

string

No comments found.

false

-

extString10

string

No comments found.

false

-

Request-example:

curl -X POST -H 'Authorization' -i /api/system/function/insert --data 'id=326&remark=frizd9&createUserId=925&creator=4u7osw&createTime=2023-09-27 17:34:58&modifyUserId=743&modifyTime=2023-09-27 17:34:58&deleteFlag=0&ignoreWarning=true&nullFields=dhuzn8,dhuzn8&changeLogId=13&parentId=790&functionCode=88129&functionIndent=lkdfxa&functionName=gil.paucek&functionVersion=0.39&functionStatus=2rislr&extString1=wckjeu&extString2=ingq09&extString3=efgbs9&extString4=arcebb&extString5=mwkgyf&extString6=dblqfc&extString7=28rbw1&extString8=x1ysu3&extString9=eoqzv6&extString10=l45yx8'

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "bydplb",
      "defaultMsg": "q4kvjy",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "4y2i56",
      "defaultMsg": "yk5x0g",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "95bfz2",
      "defaultMsg": "gzxcu6",
      "context": {
        "object": "any object"
      }
    }
  ]
}

41.2.清空消息提醒缓存

Type: GET

Author: wangding

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

Description: 清空消息提醒缓存

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Request-example:

curl -X GET -H 'Authorization' -i /api/system/function/clearCache

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "uzstld",
      "defaultMsg": "ala2fd",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "rdjzhe",
      "defaultMsg": "bapr17",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "2bwopw",
      "defaultMsg": "t9dsur",
      "context": {
        "object": "any object"
      }
    }
  ]
}

41.3.全部修改

Type: PUT

Author: wangding

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

Description: 全部修改

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

id

int64

No comments found.

false

-

remark

string

No comments found.

false

-

createUserId

int64

No comments found.

false

-

creator

string

记录创建者

false

-

createTime

string

No comments found.

false

-

modifyUserId

int64

No comments found.

false

-

modifyTime

string

No comments found.

false

-

deleteFlag

int32

No comments found.

false

-

ignoreWarning

boolean

No comments found.

false

-

nullFields

array

No comments found.

false

-

changeLogId

int64

No comments found.

false

-

parentId

int64

No comments found.

false

-

functionCode

string

No comments found.

false

-

functionIndent

string

No comments found.

false

-

functionName

string

No comments found.

false

-

functionVersion

string

No comments found.

false

-

functionStatus

string

No comments found.

false

-

extString1

string

No comments found.

false

-

extString2

string

No comments found.

false

-

extString3

string

No comments found.

false

-

extString4

string

No comments found.

false

-

extString5

string

No comments found.

false

-

extString6

string

No comments found.

false

-

extString7

string

No comments found.

false

-

extString8

string

No comments found.

false

-

extString9

string

No comments found.

false

-

extString10

string

No comments found.

false

-

Request-example:

curl -X PUT -H 'Authorization' -i /api/system/function/update --data 'id=891&remark=qflo49&createUserId=645&creator=0p4qqs&createTime=2023-09-27 17:34:58&modifyUserId=369&modifyTime=2023-09-27 17:34:58&deleteFlag=0&ignoreWarning=true&nullFields=41rxlb,41rxlb&changeLogId=27&parentId=36&functionCode=88129&functionIndent=24ceag&functionName=gil.paucek&functionVersion=0.39&functionStatus=5l1evy&extString1=hvxq9l&extString2=7wlg12&extString3=gj0n2z&extString4=m4zata&extString5=pvfxem&extString6=13w5q1&extString7=2w4fge&extString8=io89cg&extString9=9w559s&extString10=61iod2'

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "l7di79",
      "defaultMsg": "0eyjbx",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "gvxxvi",
      "defaultMsg": "kkedli",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "rwkdiv",
      "defaultMsg": "p8xj69",
      "context": {
        "object": "any object"
      }
    }
  ]
}

41.4.物理删除

Type: DELETE

Author: wangding

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

Description: 物理删除

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

keys

array

主键,[array of int64]

false

-

Request-example:

curl -X DELETE -H 'Authorization' -i /api/system/function/delete?keys=smvtkz&keys=smvtkz

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "q22bbo",
      "defaultMsg": "oon2xm",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "qhme0g",
      "defaultMsg": "8gzcrz",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "glqit9",
      "defaultMsg": "pou4kt",
      "context": {
        "object": "any object"
      }
    }
  ]
}

41.5.根据主键查询

Type: GET

Author: wangding

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

Description: 根据主键查询

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Path-parameters:

ParameterTypeDescriptionRequiredSince

key

int64

主键

true

-

Request-example:

curl -X GET -H 'Authorization' -i /api/system/function/289

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "z4w93j",
      "defaultMsg": "k9s8yg",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "w4ix6h",
      "defaultMsg": "nnemc8",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "6scxxd",
      "defaultMsg": "mp3h9w",
      "context": {
        "object": "any object"
      }
    }
  ]
}

41.6.分页查询

Type: GET

Author: wangding

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

Description: 分页查询

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

current

int32

页码，默认为1

false

-

size

int32

页大小，默认为10

false

-

keyword

string

搜索关键字

false

-

idSet

object

ID

false

-

orders

array

排序

false

-

└─column

string

属性名称

false

-

└─asc

boolean

是否升序

false

-

id

int64

No comments found.

false

-

remark

string

No comments found.

false

-

createUserId

int64

No comments found.

false

-

loginUserId

int64

登录用户id 用于数据权限

false

-

createTimeStart

string

No comments found.

false

-

createTimeEnd

string

No comments found.

false

-

modifyUserId

int64

No comments found.

false

-

modifyTimeStart

string

No comments found.

false

-

modifyTimeEnd

string

No comments found.

false

-

dataPermissionFlag

boolean

No comments found.

false

-

parentId

int64

No comments found.

false

-

functionCode

string

No comments found.

false

-

functionIndent

string

No comments found.

false

-

functionName

string

No comments found.

false

-

functionVersion

string

No comments found.

false

-

functionStatus

string

No comments found.

false

-

extString1

string

No comments found.

false

-

extString2

string

No comments found.

false

-

extString3

string

No comments found.

false

-

extString4

string

No comments found.

false

-

extString5

string

No comments found.

false

-

extString6

string

No comments found.

false

-

extString7

string

No comments found.

false

-

extString8

string

No comments found.

false

-

extString9

string

No comments found.

false

-

extString10

string

No comments found.

false

-

Request-example:

curl -X GET -H 'Authorization' -i /api/system/function/paging?current=696&size=10&keyword=rj2ubs&column=50pbg2&asc=true&id=616&remark=hvattr&createUserId=675&loginUserId=524&createTimeStart=2023-09-27 17:34:58&createTimeEnd=2023-09-27 17:34:58&modifyUserId=835&modifyTimeStart=2023-09-27 17:34:58&modifyTimeEnd=2023-09-27 17:34:58&dataPermissionFlag=true&parentId=418&functionCode=88129&functionIndent=47v2f4&functionName=gil.paucek&functionVersion=0.39&functionStatus=wxl3ie&extString1=zjjzz1&extString2=xwqlai&extString3=3yrayk&extString4=4bmism&extString5=0aoeu1&extString6=pg7hcq&extString7=7txojf&extString8=zowtzx&extString9=uzgvle&extString10=ovnhm2&orders[0].asc=true&orders[0].column=byqlca

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "ok4pf9",
      "defaultMsg": "n7mstz",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "h8reo0",
      "defaultMsg": "htzxsc",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "4pvupx",
      "defaultMsg": "5ono2p",
      "context": {
        "object": "any object"
      }
    }
  ]
}

41.7.列表查询

Type: GET

Author: wangding

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

Description: 列表查询

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

current

int32

页码，默认为1

false

-

size

int32

页大小，默认为10

false

-

keyword

string

搜索关键字

false

-

idSet

object

ID

false

-

orders

array

排序

false

-

└─column

string

属性名称

false

-

└─asc

boolean

是否升序

false

-

id

int64

No comments found.

false

-

remark

string

No comments found.

false

-

createUserId

int64

No comments found.

false

-

loginUserId

int64

登录用户id 用于数据权限

false

-

createTimeStart

string

No comments found.

false

-

createTimeEnd

string

No comments found.

false

-

modifyUserId

int64

No comments found.

false

-

modifyTimeStart

string

No comments found.

false

-

modifyTimeEnd

string

No comments found.

false

-

dataPermissionFlag

boolean

No comments found.

false

-

parentId

int64

No comments found.

false

-

functionCode

string

No comments found.

false

-

functionIndent

string

No comments found.

false

-

functionName

string

No comments found.

false

-

functionVersion

string

No comments found.

false

-

functionStatus

string

No comments found.

false

-

extString1

string

No comments found.

false

-

extString2

string

No comments found.

false

-

extString3

string

No comments found.

false

-

extString4

string

No comments found.

false

-

extString5

string

No comments found.

false

-

extString6

string

No comments found.

false

-

extString7

string

No comments found.

false

-

extString8

string

No comments found.

false

-

extString9

string

No comments found.

false

-

extString10

string

No comments found.

false

-

Request-example:

curl -X GET -H 'Authorization' -i /api/system/function/list?current=660&size=10&keyword=xmdtnq&column=v28yr8&asc=true&id=803&remark=t4ejn2&createUserId=828&loginUserId=518&createTimeStart=2023-09-27 17:34:58&createTimeEnd=2023-09-27 17:34:58&modifyUserId=439&modifyTimeStart=2023-09-27 17:34:58&modifyTimeEnd=2023-09-27 17:34:58&dataPermissionFlag=true&parentId=246&functionCode=88129&functionIndent=xoo1pe&functionName=gil.paucek&functionVersion=0.39&functionStatus=wzjtba&extString1=10l5ws&extString2=ongeij&extString3=rcx5i8&extString4=7i4kcs&extString5=o6uuqk&extString6=w29xy3&extString7=oyxvff&extString8=fvtqiz&extString9=gaaqt9&extString10=4h70mo&orders[0].column=6b94gz&orders[0].asc=true

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "v52x6g",
      "defaultMsg": "cerrgb",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "7z01f3",
      "defaultMsg": "i664i8",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "4go1ew",
      "defaultMsg": "1lflps",
      "context": {
        "object": "any object"
      }
    }
  ]
}

42.操作日志

42.1.操作日志-分页

Type: GET

Author: duwh

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

Description: 操作日志-分页

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

current

int32

页码，默认为1

false

-

size

int32

页大小，默认为10

false

-

keyword

string

搜索关键字

false

-

idSet

object

ID

false

-

orders

array

排序

false

-

└─column

string

属性名称

false

-

└─asc

boolean

是否升序

false

-

id

int64

No comments found.

false

-

remark

string

No comments found.

false

-

createUserId

int64

No comments found.

false

-

loginUserId

int64

登录用户id 用于数据权限

false

-

createTimeStart

string

No comments found.

false

-

createTimeEnd

string

No comments found.

false

-

modifyUserId

int64

No comments found.

false

-

modifyTimeStart

string

No comments found.

false

-

modifyTimeEnd

string

No comments found.

false

-

dataPermissionFlag

boolean

No comments found.

false

-

objectId

int64

业务主键

false

-

logObject

string

日志类型

false

-

logContent

string

日志内容

false

-

Request-example:

curl -X GET -H 'Authorization' -i /api/system/log/paging?current=279&size=10&keyword=40yh2l&column=u9cpol&asc=true&id=525&remark=ksf7ej&createUserId=144&loginUserId=679&createTimeStart=2023-09-27 17:34:58&createTimeEnd=2023-09-27 17:34:58&modifyUserId=758&modifyTimeStart=2023-09-27 17:34:58&modifyTimeEnd=2023-09-27 17:34:58&dataPermissionFlag=true&objectId=849&logObject=lh40rt&logContent=lthbdo&orders[0].column=37viuc&orders[0].asc=true

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "th7s8g",
      "defaultMsg": "u1snau",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "yi1ssh",
      "defaultMsg": "poji13",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "rn1k73",
      "defaultMsg": "jelpcj",
      "context": {
        "object": "any object"
      }
    }
  ]
}

42.2.操作日志-查询列表

Type: GET

Author: duwh

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

Description: 操作日志-查询列表

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

objectId

int64

业务主键

false

-

logObject

string

类型

false

-

Request-example:

curl -X GET -H 'Authorization' -i /api/system/log/list?objectId=7&logObject=m9mbp6

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "4x2wdz",
      "defaultMsg": "2tra38",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "et00w7",
      "defaultMsg": "5hfriu",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "wbno99",
      "defaultMsg": "uyiwt8",
      "context": {
        "object": "any object"
      }
    }
  ]
}

43.消息配置管理

43.1.新建

Type: POST

Author: wangding

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

Description: 新建

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

id

int64

No comments found.

false

-

remark

string

No comments found.

false

-

createUserId

int64

No comments found.

false

-

creator

string

记录创建者

false

-

createTime

string

No comments found.

false

-

modifyUserId

int64

No comments found.

false

-

modifyTime

string

No comments found.

false

-

deleteFlag

int32

No comments found.

false

-

ignoreWarning

boolean

No comments found.

false

-

nullFields

array

No comments found.

false

-

changeLogId

int64

No comments found.

false

-

messageCode

string

消息编号

false

-

messageTitle

string

消息标题

false

-

messageContent

string

消息内容

false

-

contentType

string

消息类别

false

-

contentBigType

string

消息大类

false

-

releaseSource

string

发布来源， （以谁的名义发布该条消息，默认是个人）

false

-

createSource

string

发布来源具体对象， （以谁的名义发布该条消息，个人，系统，组织，角色等，默认是个人）

false

-

noticeWay

string

通知方式

false

-

noticeScope

string

通知范围

false

-

noticeSource

string

通知范围的关联项，如果选择角色，部门，个人 提交以','分割id或编号

false

-

triggerWay

string

触发方式 定时，业务,默认是定时

false

-

triggerTimeExpression

string

定时发布（触发时间表达式）

false

-

triggerTime

string

定时发布（单次发布具体时间）

false

-

expressionExplain

string

表达式说明

false

-

messageTag

string

消息标签

false

-

releaseStatus

int32

发布状态 0新建,1发布中(循环发布),2已撤回,3已发布

false

-

messageType

int32

资源类型 1:消息配置，2:消息发送

false

-

isEnable

int32

是否启用 0:启用，1：禁用

false

-

objectId

int64

业务数据id

false

-

action

string

业务数据具体业务

false

-

Request-example:

curl -X POST -H 'Authorization' -i /api/system/message/insert --data 'id=348&remark=pybxmx&createUserId=625&creator=sxu2n2&createTime=2023-09-27 17:34:58&modifyUserId=749&modifyTime=2023-09-27 17:34:58&deleteFlag=0&ignoreWarning=true&nullFields=8s2fiy,8s2fiy&changeLogId=490&messageCode=88129&messageTitle=99aayd&messageContent=ndndx2&contentType=0djpom&contentBigType=jshge2&releaseSource=j2hqhv&createSource=aq7lxh¬iceWay=8641hc¬iceScope=5fzujc¬iceSource=6tvc6d&triggerWay=qqf4ck&triggerTimeExpression=atwnzz&triggerTime=2023-09-27 17:34:58&expressionExplain=r3q13n&messageTag=9qp3fl&releaseStatus=521&messageType=877&isEnable=722&objectId=521&action=wti29s'

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "oia0hb",
      "defaultMsg": "658ul3",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "kpgdf2",
      "defaultMsg": "a3owte",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "pggq7r",
      "defaultMsg": "pn59vt",
      "context": {
        "object": "any object"
      }
    }
  ]
}

43.2.撤回

Type: PUT

Author: wangding

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

Description: 撤回

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

keys

array

主键,[array of int64]

false

-

Request-example:

curl -X PUT -H 'Authorization' -i /api/system/message/recall --data 'keys=8cjnpm&keys=8cjnpm'

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "k8ioc5",
      "defaultMsg": "pducna",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "f8l3db",
      "defaultMsg": "17qgdt",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "02d84d",
      "defaultMsg": "cclrdn",
      "context": {
        "object": "any object"
      }
    }
  ]
}

43.3.修改

Type: PUT

Author: wangding

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

Description: 修改

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

id

int64

No comments found.

false

-

remark

string

No comments found.

false

-

createUserId

int64

No comments found.

false

-

creator

string

记录创建者

false

-

createTime

string

No comments found.

false

-

modifyUserId

int64

No comments found.

false

-

modifyTime

string

No comments found.

false

-

deleteFlag

int32

No comments found.

false

-

ignoreWarning

boolean

No comments found.

false

-

nullFields

array

No comments found.

false

-

changeLogId

int64

No comments found.

false

-

messageCode

string

消息编号

false

-

messageTitle

string

消息标题

false

-

messageContent

string

消息内容

false

-

contentType

string

消息类别

false

-

contentBigType

string

消息大类

false

-

releaseSource

string

发布来源， （以谁的名义发布该条消息，默认是个人）

false

-

createSource

string

发布来源具体对象， （以谁的名义发布该条消息，个人，系统，组织，角色等，默认是个人）

false

-

noticeWay

string

通知方式

false

-

noticeScope

string

通知范围

false

-

noticeSource

string

通知范围的关联项，如果选择角色，部门，个人 提交以','分割id或编号

false

-

triggerWay

string

触发方式 定时，业务,默认是定时

false

-

triggerTimeExpression

string

定时发布（触发时间表达式）

false

-

triggerTime

string

定时发布（单次发布具体时间）

false

-

expressionExplain

string

表达式说明

false

-

messageTag

string

消息标签

false

-

releaseStatus

int32

发布状态 0新建,1发布中(循环发布),2已撤回,3已发布

false

-

messageType

int32

资源类型 1:消息配置，2:消息发送

false

-

isEnable

int32

是否启用 0:启用，1：禁用

false

-

objectId

int64

业务数据id

false

-

action

string

业务数据具体业务

false

-

Request-example:

curl -X PUT -H 'Authorization' -i /api/system/message/update --data 'id=591&remark=lm4yr6&createUserId=381&creator=iktcmz&createTime=2023-09-27 17:34:58&modifyUserId=12&modifyTime=2023-09-27 17:34:58&deleteFlag=0&ignoreWarning=true&nullFields=ashsqm,ashsqm&changeLogId=77&messageCode=88129&messageTitle=qz2ivk&messageContent=pmv16p&contentType=zpav1m&contentBigType=nrssit&releaseSource=cwiwly&createSource=nsnxrk¬iceWay=938ami¬iceScope=njmp1y¬iceSource=hlhuz3&triggerWay=dvsvur&triggerTimeExpression=ib4i2i&triggerTime=2023-09-27 17:34:58&expressionExplain=z0c8xb&messageTag=wes3us&releaseStatus=336&messageType=369&isEnable=47&objectId=678&action=wj46sx'

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "li5hsh",
      "defaultMsg": "yn43un",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "13z1ap",
      "defaultMsg": "c1d6xq",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "22n31q",
      "defaultMsg": "2ptdhv",
      "context": {
        "object": "any object"
      }
    }
  ]
}

43.4.逻辑删除

Type: DELETE

Author: wangding

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

Description: 逻辑删除

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

keys

array

主键,[array of int64]

false

-

Request-example:

curl -X DELETE -H 'Authorization' -i /api/system/message/deleteSoft?keys=4eifja&keys=4eifja

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "hita2b",
      "defaultMsg": "nwy4xn",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "o51g82",
      "defaultMsg": "67dphi",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "m2r8ys",
      "defaultMsg": "lg2t1x",
      "context": {
        "object": "any object"
      }
    }
  ]
}

43.5.通过通知范围查询通知数据

Type: GET

Author: wangding

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

Description: 通过通知范围查询通知数据

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

noticeScope

string

通知范围

false

-

Request-example:

curl -X GET -H 'Authorization' -i /api/system/message/queryDatas?noticeScope=8tjmzc

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "h7gc6f",
      "defaultMsg": "q7p8l8",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "m11hpe",
      "defaultMsg": "mh8pro",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "ww89hf",
      "defaultMsg": "934zwz",
      "context": {
        "object": "any object"
      }
    }
  ]
}

43.6.查询发布来源数据

Type: GET

Author: wangding

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

Description: 查询发布来源数据

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

releaseSource

string

发布来源

false

-

Request-example:

curl -X GET -H 'Authorization' -i /api/system/message/queryMyDatas?releaseSource=p9vh53

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "zf6rib",
      "defaultMsg": "dwhl2g",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "h7u740",
      "defaultMsg": "nzzkli",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "p6xbbc",
      "defaultMsg": "n7hh9p",
      "context": {
        "object": "any object"
      }
    }
  ]
}

43.7.物理删除

Type: DELETE

Author: wangding

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

Description: 物理删除

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

keys

array

主键,[array of int64]

false

-

Request-example:

curl -X DELETE -H 'Authorization' -i /api/system/message/delete?keys=25ju5v&keys=25ju5v

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "3dk2u0",
      "defaultMsg": "j32gkt",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "ee0pvc",
      "defaultMsg": "9mxmfq",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "omddio",
      "defaultMsg": "3kqs77",
      "context": {
        "object": "any object"
      }
    }
  ]
}

43.8.根据主键查询

Type: GET

Author: wangding

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

Description: 根据主键查询

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Path-parameters:

ParameterTypeDescriptionRequiredSince

key

int64

主键

true

-

Request-example:

curl -X GET -H 'Authorization' -i /api/system/message/108

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "jh5sis",
      "defaultMsg": "slxar6",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "afg9dc",
      "defaultMsg": "8m1upl",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "puqm4w",
      "defaultMsg": "f7qugl",
      "context": {
        "object": "any object"
      }
    }
  ]
}

43.9.分页查询

Type: GET

Author: wangding

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

Description: 分页查询

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

current

int32

页码，默认为1

false

-

size

int32

页大小，默认为10

false

-

keyword

string

搜索关键字

false

-

idSet

object

ID

false

-

orders

array

排序

false

-

└─column

string

属性名称

false

-

└─asc

boolean

是否升序

false

-

id

int64

No comments found.

false

-

remark

string

No comments found.

false

-

createUserId

int64

No comments found.

false

-

loginUserId

int64

登录用户id 用于数据权限

false

-

createTimeStart

string

No comments found.

false

-

createTimeEnd

string

No comments found.

false

-

modifyUserId

int64

No comments found.

false

-

modifyTimeStart

string

No comments found.

false

-

modifyTimeEnd

string

No comments found.

false

-

dataPermissionFlag

boolean

No comments found.

false

-

messageCode

string

消息编号

false

-

messageTitle

string

消息标题

false

-

messageContent

string

消息内容

false

-

contentType

string

消息类别

false

-

contentBigType

string

消息大类

false

-

releaseSource

string

发布来源， （以谁的名义发布该条消息，默认是个人）

false

-

createSource

string

发布来源具体对象， （以谁的名义发布该条消息，个人，系统，组织，角色等，默认是个人）

false

-

noticeWay

string

通知方式

false

-

noticeScope

string

通知范围

false

-

noticeSource

string

通知范围的关联项，如果选择角色，部门，个人 提交以','分割id或编号

false

-

triggerWay

string

触发方式 定时，业务

false

-

triggerTimeExpression

string

定时发布（触发时间表达式）

false

-

releaseTimeStart

string

发布时间起

false

-

releaseTimeEnd

string

发布时间止

false

-

expressionExplain

string

表达式说明

false

-

messageTag

string

消息标签

false

-

releaseStatus

int32

No comments found.

false

-

messageType

int32

资源类型 1:运维人员，2:行政管理员

false

-

isEnable

int32

是否启用 0:启用，1：禁用

false

-

Request-example:

curl -X GET -H 'Authorization' -i /api/system/message/paging?current=22&size=10&keyword=zwfipc&column=i4jcw4&asc=true&id=612&remark=9vlegu&createUserId=372&loginUserId=786&createTimeStart=2023-09-27 17:34:58&createTimeEnd=2023-09-27 17:34:58&modifyUserId=372&modifyTimeStart=2023-09-27 17:34:58&modifyTimeEnd=2023-09-27 17:34:58&dataPermissionFlag=true&messageCode=88129&messageTitle=dz8ouz&messageContent=rtb6ho&contentType=gnggzo&contentBigType=zzxe9k&releaseSource=y8hoyz&createSource=i47wch¬iceWay=2q649e¬iceScope=fxrd30¬iceSource=k1fz98&triggerWay=lvsjji&triggerTimeExpression=onfuvm&releaseTimeStart=2023-09-27 17:34:58&releaseTimeEnd=2023-09-27 17:34:58&expressionExplain=0tmccg&messageTag=7cd5br&releaseStatus=821&messageType=811&isEnable=36&orders[0].column=1mw146&orders[0].asc=true

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "hnwacq",
      "defaultMsg": "681meu",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "x6p3gi",
      "defaultMsg": "gq6tei",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "syqrif",
      "defaultMsg": "mpfsqm",
      "context": {
        "object": "any object"
      }
    }
  ]
}

43.10.一键发布

Type: PUT

Author: wangding

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

Description: 一键发布

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

keys

array

主键,[array of int64]

false

-

Request-example:

curl -X PUT -H 'Authorization' -i /api/system/message/onKeyRelease --data 'keys=lbs8we&keys=lbs8we'

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "07bevq",
      "defaultMsg": "v92tos",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "8n3811",
      "defaultMsg": "urru4e",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "w68i9u",
      "defaultMsg": "99ixrv",
      "context": {
        "object": "any object"
      }
    }
  ]
}

44.系统角色管理

44.1.新建

Type: POST

Author: wangding

Content-Type: application/json

Description: 新建

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Body-parameters:

ParameterTypeDescriptionRequiredSince

id

int64

No comments found.

false

-

remark

string

No comments found.

false

-

createUserId

int64

No comments found.

false

-

creator

string

记录创建者

false

-

createTime

string

No comments found.

false

-

modifyUserId

int64

No comments found.

false

-

modifyTime

string

No comments found.

false

-

deleteFlag

int32

No comments found.

false

-

ignoreWarning

boolean

No comments found.

false

-

nullFields

array

No comments found.

false

-

changeLogId

int64

No comments found.

false

-

roleCode

string

角色编号

false

-

roleName

string

角色名称

false

-

enabled

boolean

角色启用状态

false

-

menuIds

array

角色菜单ids 如果修改的时候传值是 “null”表示赋值菜单没有改变，如果是空数组“[]”表示把赋值菜单全部删除

false

-

userIds

array

员工ids 如果修改的时候传值是 “null”表示赋值员工没有改变，如果是空数组“[]”表示把赋值员工全部删除

false

-

sortIndex

int32

角色排序

false

-

initTenantId

int64

通过租户初始化数据 租户id

false

-

Request-example:

curl -X POST -H 'Content-Type: application/json' -H 'Authorization' -i /api/system/role/insert --data '{
  "id": 142,
  "remark": "krip1o",
  "createUserId": 893,
  "creator": "jm20pu",
  "createTime": "2023-09-27 17:34:58",
  "modifyUserId": 414,
  "modifyTime": "2023-09-27 17:34:58",
  "deleteFlag": 0,
  "ignoreWarning": true,
  "nullFields": [
    "kemorj"
  ],
  "changeLogId": 144,
  "roleCode": "88129",
  "roleName": "gil.paucek",
  "enabled": true,
  "menuIds": [
    442
  ],
  "userIds": [
    280
  ],
  "sortIndex": 1,
  "initTenantId": 814
}'

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "bm56no",
      "defaultMsg": "0x8hvr",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "bh3ti4",
      "defaultMsg": "dos3yk",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "s2jre6",
      "defaultMsg": "02tbu6",
      "context": {
        "object": "any object"
      }
    }
  ]
}

44.2.状态修改

Type: PUT

Author: wangding

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

Description: 状态修改

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

id

int64

主键

false

-

enabled

boolean

状态

false

-

Request-example:

curl -X PUT -H 'Authorization' -i /api/system/role/updateStatus --data 'id=243&enabled=true'

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "tbeuv1",
      "defaultMsg": "58q212",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "mw24lq",
      "defaultMsg": "yh8juk",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "00rlen",
      "defaultMsg": "dicl6p",
      "context": {
        "object": "any object"
      }
    }
  ]
}

44.3.修改

Type: PUT

Author: wangding

Content-Type: application/json

Description: 修改

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Body-parameters:

ParameterTypeDescriptionRequiredSince

id

int64

No comments found.

false

-

remark

string

No comments found.

false

-

createUserId

int64

No comments found.

false

-

creator

string

记录创建者

false

-

createTime

string

No comments found.

false

-

modifyUserId

int64

No comments found.

false

-

modifyTime

string

No comments found.

false

-

deleteFlag

int32

No comments found.

false

-

ignoreWarning

boolean

No comments found.

false

-

nullFields

array

No comments found.

false

-

changeLogId

int64

No comments found.

false

-

roleCode

string

角色编号

false

-

roleName

string

角色名称

false

-

enabled

boolean

角色启用状态

false

-

menuIds

array

角色菜单ids 如果修改的时候传值是 “null”表示赋值菜单没有改变，如果是空数组“[]”表示把赋值菜单全部删除

false

-

userIds

array

员工ids 如果修改的时候传值是 “null”表示赋值员工没有改变，如果是空数组“[]”表示把赋值员工全部删除

false

-

sortIndex

int32

角色排序

false

-

initTenantId

int64

通过租户初始化数据 租户id

false

-

Request-example:

curl -X PUT -H 'Content-Type: application/json' -H 'Authorization' -i /api/system/role/update --data '{
  "id": 951,
  "remark": "6rg75u",
  "createUserId": 668,
  "creator": "5uaheg",
  "createTime": "2023-09-27 17:34:58",
  "modifyUserId": 24,
  "modifyTime": "2023-09-27 17:34:58",
  "deleteFlag": 0,
  "ignoreWarning": true,
  "nullFields": [
    "jcrycl"
  ],
  "changeLogId": 535,
  "roleCode": "88129",
  "roleName": "gil.paucek",
  "enabled": true,
  "menuIds": [
    101
  ],
  "userIds": [
    213
  ],
  "sortIndex": 1,
  "initTenantId": 198
}'

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "l24fjt",
      "defaultMsg": "4fkaj6",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "9eg2pj",
      "defaultMsg": "k6h7ge",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "wghcz4",
      "defaultMsg": "w29qiw",
      "context": {
        "object": "any object"
      }
    }
  ]
}

44.4.逻辑删除

Type: DELETE

Author: wangding

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

Description: 逻辑删除

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

keys

array

主键,[array of int64]

false

-

Request-example:

curl -X DELETE -H 'Authorization' -i /api/system/role/deleteSoft?keys=lwzezs&keys=lwzezs

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "wpzxus",
      "defaultMsg": "yd2dp4",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "myjy8u",
      "defaultMsg": "oxzvt0",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "ckd2xj",
      "defaultMsg": "tacclf",
      "context": {
        "object": "any object"
      }
    }
  ]
}

44.5.根据主键查询

Type: GET

Author: wangding

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

Description: 根据主键查询

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Path-parameters:

ParameterTypeDescriptionRequiredSince

key

int64

主键

true

-

Request-example:

curl -X GET -H 'Authorization' -i /api/system/role/626

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "xzrp4d",
      "defaultMsg": "bxjj97",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "np2v4e",
      "defaultMsg": "h1gxt7",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "4xck35",
      "defaultMsg": "84capx",
      "context": {
        "object": "any object"
      }
    }
  ]
}

44.6.列表查询

Type: GET

Author: wangding

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

Description: 列表查询

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Request-example:

curl -X GET -H 'Authorization' -i /api/system/role/list

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "aowo7g",
      "defaultMsg": "stomv8",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "m3llzg",
      "defaultMsg": "k6tadz",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "6osu60",
      "defaultMsg": "c7rl8a",
      "context": {
        "object": "any object"
      }
    }
  ]
}

44.7.分页查询

Type: GET

Author: wangding

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

Description: 分页查询

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

current

int32

页码，默认为1

false

-

size

int32

页大小，默认为10

false

-

keyword

string

搜索关键字

false

-

idSet

object

ID

false

-

orders

array

排序

false

-

└─column

string

属性名称

false

-

└─asc

boolean

是否升序

false

-

id

int64

No comments found.

false

-

remark

string

No comments found.

false

-

createUserId

int64

No comments found.

false

-

loginUserId

int64

登录用户id 用于数据权限

false

-

createTimeStart

string

No comments found.

false

-

createTimeEnd

string

No comments found.

false

-

modifyUserId

int64

No comments found.

false

-

modifyTimeStart

string

No comments found.

false

-

modifyTimeEnd

string

No comments found.

false

-

dataPermissionFlag

boolean

No comments found.

false

-

roleCode

string

角色启用状态

false

-

roleName

string

角色名称

false

-

enabled

boolean

角色启用状态

false

-

Request-example:

curl -X GET -H 'Authorization' -i /api/system/role/paging?current=193&size=10&keyword=dz4v39&column=nf29di&asc=true&id=737&remark=726xbk&createUserId=924&loginUserId=926&createTimeStart=2023-09-27 17:34:58&createTimeEnd=2023-09-27 17:34:58&modifyUserId=562&modifyTimeStart=2023-09-27 17:34:58&modifyTimeEnd=2023-09-27 17:34:58&dataPermissionFlag=true&roleCode=88129&roleName=gil.paucek&enabled=true&orders[0].asc=true&orders[0].column=wj9bf3

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "yh6nnc",
      "defaultMsg": "xbxevw",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "3ii9sr",
      "defaultMsg": "eqkuq0",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "xngdoh",
      "defaultMsg": "ud6uig",
      "context": {
        "object": "any object"
      }
    }
  ]
}

45.系统功能处理-问题反馈

45.1.新建

Type: POST

Author: Lemon

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

Description: 新建

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

id

int64

No comments found.

false

-

remark

string

No comments found.

false

-

createUserId

int64

No comments found.

false

-

creator

string

记录创建者

false

-

createTime

string

No comments found.

false

-

modifyUserId

int64

No comments found.

false

-

modifyTime

string

No comments found.

false

-

deleteFlag

int32

No comments found.

false

-

ignoreWarning

boolean

No comments found.

false

-

nullFields

array

No comments found.

false

-

changeLogId

int64

No comments found.

false

-

feedbackTitle

string

反馈标题

false

-

problemUrl

string

问题url

false

-

fileCodes

string

附加

false

-

feedbackStatus

string

反馈状态

false

-

closeReason

string

关闭理由

false

-

closeReasonDesc

string

关闭理由说明

false

-

urgentFlag

int32

加急标识，0：不加急，1：加急

false

-

replyStatus

string

回复状态

false

-

content

string

内容

false

-

problemType

string

问题类型

false

-

functionId

int64

所属功能

false

-

directorUserId

int64

负责人

false

-

readAmount

int64

阅览量

false

-

tags

string

标签

false

-

commonFlag

int32

常用问题标识

false

-

handleIds

array

需要处理的问题ids

false

-

level

string

严重程度

false

-

Request-example:

curl -X POST -H 'Authorization' -i /API_SYSTEM/problemFeedback/insert --data 'id=485&remark=2id7n1&createUserId=870&creator=h4tu84&createTime=2023-09-27 17:34:58&modifyUserId=972&modifyTime=2023-09-27 17:34:58&deleteFlag=0&ignoreWarning=true&nullFields=iphkxq,iphkxq&changeLogId=34&feedbackTitle=c1p6ka&problemUrl=www.lauretta-parisian.org&fileCodes=c84yxq&feedbackStatus=s484m7&closeReason=8xguvi&closeReasonDesc=rt98bh&urgentFlag=0&replyStatus=wyalfl&content=dxh9v1&problemType=h9x8vo&functionId=905&directorUserId=628&readAmount=972&tags=okvigo&commonFlag=0&handleIds=359,359&level=2ln5ul'

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "vzq5cd",
      "defaultMsg": "3pwb4q",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "q057gc",
      "defaultMsg": "cd4d4u",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "rhz910",
      "defaultMsg": "ldya7s",
      "context": {
        "object": "any object"
      }
    }
  ]
}

45.2.全部修改

Type: PUT

Author: Lemon

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

Description: 全部修改

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

id

int64

No comments found.

false

-

remark

string

No comments found.

false

-

createUserId

int64

No comments found.

false

-

creator

string

记录创建者

false

-

createTime

string

No comments found.

false

-

modifyUserId

int64

No comments found.

false

-

modifyTime

string

No comments found.

false

-

deleteFlag

int32

No comments found.

false

-

ignoreWarning

boolean

No comments found.

false

-

nullFields

array

No comments found.

false

-

changeLogId

int64

No comments found.

false

-

feedbackTitle

string

反馈标题

false

-

problemUrl

string

问题url

false

-

fileCodes

string

附加

false

-

feedbackStatus

string

反馈状态

false

-

closeReason

string

关闭理由

false

-

closeReasonDesc

string

关闭理由说明

false

-

urgentFlag

int32

加急标识，0：不加急，1：加急

false

-

replyStatus

string

回复状态

false

-

content

string

内容

false

-

problemType

string

问题类型

false

-

functionId

int64

所属功能

false

-

directorUserId

int64

负责人

false

-

readAmount

int64

阅览量

false

-

tags

string

标签

false

-

commonFlag

int32

常用问题标识

false

-

handleIds

array

需要处理的问题ids

false

-

level

string

严重程度

false

-

Request-example:

curl -X PUT -H 'Authorization' -i /API_SYSTEM/problemFeedback/update --data 'id=542&remark=zur5u1&createUserId=552&creator=tdyelm&createTime=2023-09-27 17:34:58&modifyUserId=631&modifyTime=2023-09-27 17:34:58&deleteFlag=0&ignoreWarning=true&nullFields=99gmtj,99gmtj&changeLogId=291&feedbackTitle=e64bbe&problemUrl=www.lauretta-parisian.org&fileCodes=4vtmns&feedbackStatus=6fpv5s&closeReason=jc8k0v&closeReasonDesc=bgb2ty&urgentFlag=0&replyStatus=u8a9wn&content=6dgziv&problemType=uetyz9&functionId=892&directorUserId=631&readAmount=523&tags=td5ecw&commonFlag=0&handleIds=314,314&level=zygodz'

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "lqq3i9",
      "defaultMsg": "51bb9u",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "qkwy46",
      "defaultMsg": "11dujj",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "q8lrvv",
      "defaultMsg": "k260ks",
      "context": {
        "object": "any object"
      }
    }
  ]
}

45.3.

Type: GET

Author: Lemon

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

Description: 

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

current

int32

页码，默认为1

false

-

size

int32

页大小，默认为10

false

-

keyword

string

搜索关键字

false

-

idSet

object

ID

false

-

orders

array

排序

false

-

└─column

string

属性名称

false

-

└─asc

boolean

是否升序

false

-

id

int64

No comments found.

false

-

remark

string

No comments found.

false

-

loginUserId

int64

登录用户id 用于数据权限

false

-

createTimeStart

string

No comments found.

false

-

createTimeEnd

string

No comments found.

false

-

modifyUserId

int64

No comments found.

false

-

modifyTimeStart

string

No comments found.

false

-

modifyTimeEnd

string

No comments found.

false

-

dataPermissionFlag

boolean

No comments found.

false

-

feedbackTitle

string

No comments found.

false

-

feedbackStatus

string

No comments found.

false

-

startCreateTime

string

No comments found.

false

-

endCreateTime

string

No comments found.

false

-

startProcessCreateTime

string

No comments found.

false

-

endProcessCreateTime

string

No comments found.

false

-

problemType

string

No comments found.

false

-

functionId

int64

No comments found.

false

-

directorUserId

int64

No comments found.

false

-

commonFlag

int32

No comments found.

false

-

createUserId

int64

No comments found.

false

-

level

string

No comments found.

false

-

replyStatus

string

No comments found.

false

-

pageFlag

int32

No comments found.

false

-

urgentFlag

int32

加急标识，0：不加急，1：加急

false

-

opsAdmin

int64

运维管理员用户id

false

-

Request-example:

curl -X GET -H 'Authorization' -i /API_SYSTEM/problemFeedback/paging?current=412&size=10&keyword=sntbp7&column=u9b8ab&asc=true&id=328&remark=irlhaa&loginUserId=96&createTimeStart=2023-09-27 17:34:58&createTimeEnd=2023-09-27 17:34:58&modifyUserId=494&modifyTimeStart=2023-09-27 17:34:58&modifyTimeEnd=2023-09-27 17:34:58&dataPermissionFlag=true&feedbackTitle=mwmwlj&feedbackStatus=mpdafw&startCreateTime=2023-09-27 17:34:58&endCreateTime=2023-09-27 17:34:58&startProcessCreateTime=2023-09-27 17:34:58&endProcessCreateTime=2023-09-27 17:34:58&problemType=8h14f1&functionId=322&directorUserId=97&commonFlag=0&createUserId=683&level=25n7wy&replyStatus=k6h6i9&pageFlag=0&urgentFlag=0&opsAdmin=626&orders[0].asc=true&orders[0].column=tlf7dm

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "cr9neh",
      "defaultMsg": "3fpu52",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "cxhq7e",
      "defaultMsg": "b13ky6",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "n2rai4",
      "defaultMsg": "ak462q",
      "context": {
        "object": "any object"
      }
    }
  ]
}

45.4.

Type: GET

Author: Lemon

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

Description: 

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Path-parameters:

ParameterTypeDescriptionRequiredSince

key

int64

No comments found.

true

-

Request-example:

curl -X GET -H 'Authorization' -i /API_SYSTEM/problemFeedback/45

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "mm2q45",
      "defaultMsg": "bnb0p1",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "rmktwk",
      "defaultMsg": "ezot8j",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "rc3otn",
      "defaultMsg": "hpzih5",
      "context": {
        "object": "any object"
      }
    }
  ]
}

45.5.根据主键动态修改

Type: PUT

Author: Lemon

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

Description: 根据主键动态修改

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

id

int64

No comments found.

false

-

remark

string

No comments found.

false

-

createUserId

int64

No comments found.

false

-

creator

string

记录创建者

false

-

createTime

string

No comments found.

false

-

modifyUserId

int64

No comments found.

false

-

modifyTime

string

No comments found.

false

-

deleteFlag

int32

No comments found.

false

-

ignoreWarning

boolean

No comments found.

false

-

nullFields

array

No comments found.

false

-

changeLogId

int64

No comments found.

false

-

feedbackTitle

string

反馈标题

false

-

problemUrl

string

问题url

false

-

fileCodes

string

附加

false

-

feedbackStatus

string

反馈状态

false

-

closeReason

string

关闭理由

false

-

closeReasonDesc

string

关闭理由说明

false

-

urgentFlag

int32

加急标识，0：不加急，1：加急

false

-

replyStatus

string

回复状态

false

-

content

string

内容

false

-

problemType

string

问题类型

false

-

functionId

int64

所属功能

false

-

directorUserId

int64

负责人

false

-

readAmount

int64

阅览量

false

-

tags

string

标签

false

-

commonFlag

int32

常用问题标识

false

-

handleIds

array

需要处理的问题ids

false

-

level

string

严重程度

false

-

Request-example:

curl -X PUT -H 'Authorization' -i /API_SYSTEM/problemFeedback/updateByKeyDynamic --data 'id=603&remark=3dbjy6&createUserId=557&creator=n4whyt&createTime=2023-09-27 17:34:58&modifyUserId=574&modifyTime=2023-09-27 17:34:58&deleteFlag=0&ignoreWarning=true&nullFields=u9t7jr,u9t7jr&changeLogId=474&feedbackTitle=o8wqkk&problemUrl=www.lauretta-parisian.org&fileCodes=zv74c2&feedbackStatus=c55xf9&closeReason=bfayt5&closeReasonDesc=pvbems&urgentFlag=0&replyStatus=1ta9z1&content=ban5vu&problemType=da2286&functionId=340&directorUserId=708&readAmount=808&tags=jgvslv&commonFlag=0&handleIds=482,482&level=g9bumj'

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "wqiqxn",
      "defaultMsg": "c80ikh",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "uzsupt",
      "defaultMsg": "4nq9w8",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "lrs9oj",
      "defaultMsg": "f18gyu",
      "context": {
        "object": "any object"
      }
    }
  ]
}

45.6.关闭问题

Type: PUT

Author: Lemon

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

Description: 关闭问题

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

id

int64

No comments found.

false

-

remark

string

No comments found.

false

-

createUserId

int64

No comments found.

false

-

creator

string

记录创建者

false

-

createTime

string

No comments found.

false

-

modifyUserId

int64

No comments found.

false

-

modifyTime

string

No comments found.

false

-

deleteFlag

int32

No comments found.

false

-

ignoreWarning

boolean

No comments found.

false

-

nullFields

array

No comments found.

false

-

changeLogId

int64

No comments found.

false

-

feedbackTitle

string

反馈标题

false

-

problemUrl

string

问题url

false

-

fileCodes

string

附加

false

-

feedbackStatus

string

反馈状态

false

-

closeReason

string

关闭理由

false

-

closeReasonDesc

string

关闭理由说明

false

-

urgentFlag

int32

加急标识，0：不加急，1：加急

false

-

replyStatus

string

回复状态

false

-

content

string

内容

false

-

problemType

string

问题类型

false

-

functionId

int64

所属功能

false

-

directorUserId

int64

负责人

false

-

readAmount

int64

阅览量

false

-

tags

string

标签

false

-

commonFlag

int32

常用问题标识

false

-

handleIds

array

需要处理的问题ids

false

-

level

string

严重程度

false

-

Request-example:

curl -X PUT -H 'Authorization' -i /API_SYSTEM/problemFeedback/close --data 'id=132&remark=wfh52n&createUserId=103&creator=o7af8g&createTime=2023-09-27 17:34:58&modifyUserId=235&modifyTime=2023-09-27 17:34:58&deleteFlag=0&ignoreWarning=true&nullFields=6aqp7q,6aqp7q&changeLogId=30&feedbackTitle=0xj9w5&problemUrl=www.lauretta-parisian.org&fileCodes=fi6846&feedbackStatus=xn9844&closeReason=s2ebaj&closeReasonDesc=5wy7zd&urgentFlag=0&replyStatus=m8293p&content=6j3vm8&problemType=a83r23&functionId=483&directorUserId=208&readAmount=975&tags=jwn2wa&commonFlag=0&handleIds=981,981&level=34gcu3'

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "2ldxx1",
      "defaultMsg": "ohwpjb",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "3cd0lv",
      "defaultMsg": "dyxmkj",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "f0ov4y",
      "defaultMsg": "l64rd8",
      "context": {
        "object": "any object"
      }
    }
  ]
}

45.7.打开问题

Type: PUT

Author: Lemon

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

Description: 打开问题

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

id

int64

No comments found.

false

-

remark

string

No comments found.

false

-

createUserId

int64

No comments found.

false

-

creator

string

记录创建者

false

-

createTime

string

No comments found.

false

-

modifyUserId

int64

No comments found.

false

-

modifyTime

string

No comments found.

false

-

deleteFlag

int32

No comments found.

false

-

ignoreWarning

boolean

No comments found.

false

-

nullFields

array

No comments found.

false

-

changeLogId

int64

No comments found.

false

-

feedbackTitle

string

反馈标题

false

-

problemUrl

string

问题url

false

-

fileCodes

string

附加

false

-

feedbackStatus

string

反馈状态

false

-

closeReason

string

关闭理由

false

-

closeReasonDesc

string

关闭理由说明

false

-

urgentFlag

int32

加急标识，0：不加急，1：加急

false

-

replyStatus

string

回复状态

false

-

content

string

内容

false

-

problemType

string

问题类型

false

-

functionId

int64

所属功能

false

-

directorUserId

int64

负责人

false

-

readAmount

int64

阅览量

false

-

tags

string

标签

false

-

commonFlag

int32

常用问题标识

false

-

handleIds

array

需要处理的问题ids

false

-

level

string

严重程度

false

-

Request-example:

curl -X PUT -H 'Authorization' -i /API_SYSTEM/problemFeedback/open --data 'id=745&remark=xvh79v&createUserId=447&creator=fdednq&createTime=2023-09-27 17:34:58&modifyUserId=706&modifyTime=2023-09-27 17:34:58&deleteFlag=0&ignoreWarning=true&nullFields=r9wj8q,r9wj8q&changeLogId=200&feedbackTitle=gwpf91&problemUrl=www.lauretta-parisian.org&fileCodes=8xi2s4&feedbackStatus=2bajao&closeReason=9028mu&closeReasonDesc=5gqhch&urgentFlag=0&replyStatus=d93jrv&content=j0pk4e&problemType=qge42w&functionId=45&directorUserId=282&readAmount=611&tags=1w95e9&commonFlag=0&handleIds=510,510&level=2swjjp'

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "a5a5l2",
      "defaultMsg": "yah6pw",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "i8gk4l",
      "defaultMsg": "fvijte",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "uq5m5a",
      "defaultMsg": "x9f28w",
      "context": {
        "object": "any object"
      }
    }
  ]
}

45.8.申请加急问题

Type: PUT

Author: Lemon

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

Description: 申请加急问题

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

id

int64

No comments found.

false

-

remark

string

No comments found.

false

-

createUserId

int64

No comments found.

false

-

creator

string

记录创建者

false

-

createTime

string

No comments found.

false

-

modifyUserId

int64

No comments found.

false

-

modifyTime

string

No comments found.

false

-

deleteFlag

int32

No comments found.

false

-

ignoreWarning

boolean

No comments found.

false

-

nullFields

array

No comments found.

false

-

changeLogId

int64

No comments found.

false

-

feedbackTitle

string

反馈标题

false

-

problemUrl

string

问题url

false

-

fileCodes

string

附加

false

-

feedbackStatus

string

反馈状态

false

-

closeReason

string

关闭理由

false

-

closeReasonDesc

string

关闭理由说明

false

-

urgentFlag

int32

加急标识，0：不加急，1：加急

false

-

replyStatus

string

回复状态

false

-

content

string

内容

false

-

problemType

string

问题类型

false

-

functionId

int64

所属功能

false

-

directorUserId

int64

负责人

false

-

readAmount

int64

阅览量

false

-

tags

string

标签

false

-

commonFlag

int32

常用问题标识

false

-

handleIds

array

需要处理的问题ids

false

-

level

string

严重程度

false

-

Request-example:

curl -X PUT -H 'Authorization' -i /API_SYSTEM/problemFeedback/urgent --data 'id=542&remark=icjofl&createUserId=273&creator=jrfzhv&createTime=2023-09-27 17:34:58&modifyUserId=377&modifyTime=2023-09-27 17:34:58&deleteFlag=0&ignoreWarning=true&nullFields=bezb3m,bezb3m&changeLogId=800&feedbackTitle=20ocfn&problemUrl=www.lauretta-parisian.org&fileCodes=p9a3gu&feedbackStatus=ps24sk&closeReason=22olpl&closeReasonDesc=hy9u6n&urgentFlag=0&replyStatus=t7y03v&content=5pdjd4&problemType=0r88nf&functionId=884&directorUserId=457&readAmount=903&tags=y4gi59&commonFlag=0&handleIds=912,912&level=sh5ken'

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "45yh4y",
      "defaultMsg": "gyjors",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "8wsmpt",
      "defaultMsg": "q48spv",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "nzvu4s",
      "defaultMsg": "97hd2j",
      "context": {
        "object": "any object"
      }
    }
  ]
}

45.9.修改常见问题标志

Type: PUT

Author: Lemon

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

Description: 修改常见问题标志

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

id

int64

No comments found.

false

-

remark

string

No comments found.

false

-

createUserId

int64

No comments found.

false

-

creator

string

记录创建者

false

-

createTime

string

No comments found.

false

-

modifyUserId

int64

No comments found.

false

-

modifyTime

string

No comments found.

false

-

deleteFlag

int32

No comments found.

false

-

ignoreWarning

boolean

No comments found.

false

-

nullFields

array

No comments found.

false

-

changeLogId

int64

No comments found.

false

-

feedbackTitle

string

反馈标题

false

-

problemUrl

string

问题url

false

-

fileCodes

string

附加

false

-

feedbackStatus

string

反馈状态

false

-

closeReason

string

关闭理由

false

-

closeReasonDesc

string

关闭理由说明

false

-

urgentFlag

int32

加急标识，0：不加急，1：加急

false

-

replyStatus

string

回复状态

false

-

content

string

内容

false

-

problemType

string

问题类型

false

-

functionId

int64

所属功能

false

-

directorUserId

int64

负责人

false

-

readAmount

int64

阅览量

false

-

tags

string

标签

false

-

commonFlag

int32

常用问题标识

false

-

handleIds

array

需要处理的问题ids

false

-

level

string

严重程度

false

-

Request-example:

curl -X PUT -H 'Authorization' -i /API_SYSTEM/problemFeedback/common --data 'id=746&remark=tz1owu&createUserId=793&creator=pp27h3&createTime=2023-09-27 17:34:58&modifyUserId=215&modifyTime=2023-09-27 17:34:58&deleteFlag=0&ignoreWarning=true&nullFields=3mvwy7,3mvwy7&changeLogId=946&feedbackTitle=4dof41&problemUrl=www.lauretta-parisian.org&fileCodes=rjb25f&feedbackStatus=i0ot2j&closeReason=wrb5xk&closeReasonDesc=cbq0yk&urgentFlag=0&replyStatus=st14qb&content=ixl7rc&problemType=dt52jb&functionId=205&directorUserId=539&readAmount=721&tags=u6fxvd&commonFlag=0&handleIds=81,81&level=b7fve1'

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "bm612a",
      "defaultMsg": "lriy0x",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "gnxepp",
      "defaultMsg": "l4hdi1",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "b9p318",
      "defaultMsg": "dh0w4i",
      "context": {
        "object": "any object"
      }
    }
  ]
}

45.10.查询时间段内的问题数量和解决数量

Type: GET

Author: Lemon

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

Description: 查询时间段内的问题数量和解决数量

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

current

int32

页码，默认为1

false

-

size

int32

页大小，默认为10

false

-

keyword

string

搜索关键字

false

-

idSet

object

ID

false

-

orders

array

排序

false

-

└─column

string

属性名称

false

-

└─asc

boolean

是否升序

false

-

id

int64

No comments found.

false

-

remark

string

No comments found.

false

-

loginUserId

int64

登录用户id 用于数据权限

false

-

createTimeStart

string

No comments found.

false

-

createTimeEnd

string

No comments found.

false

-

modifyUserId

int64

No comments found.

false

-

modifyTimeStart

string

No comments found.

false

-

modifyTimeEnd

string

No comments found.

false

-

dataPermissionFlag

boolean

No comments found.

false

-

feedbackTitle

string

No comments found.

false

-

feedbackStatus

string

No comments found.

false

-

startCreateTime

string

No comments found.

false

-

endCreateTime

string

No comments found.

false

-

startProcessCreateTime

string

No comments found.

false

-

endProcessCreateTime

string

No comments found.

false

-

problemType

string

No comments found.

false

-

functionId

int64

No comments found.

false

-

directorUserId

int64

No comments found.

false

-

commonFlag

int32

No comments found.

false

-

createUserId

int64

No comments found.

false

-

level

string

No comments found.

false

-

replyStatus

string

No comments found.

false

-

pageFlag

int32

No comments found.

false

-

urgentFlag

int32

加急标识，0：不加急，1：加急

false

-

opsAdmin

int64

运维管理员用户id

false

-

Request-example:

curl -X GET -H 'Authorization' -i /API_SYSTEM/problemFeedback/statisticalNumber?current=769&size=10&keyword=a4nnh4&column=75ipez&asc=true&id=189&remark=qqkz0o&loginUserId=739&createTimeStart=2023-09-27 17:34:58&createTimeEnd=2023-09-27 17:34:58&modifyUserId=201&modifyTimeStart=2023-09-27 17:34:58&modifyTimeEnd=2023-09-27 17:34:58&dataPermissionFlag=true&feedbackTitle=713bld&feedbackStatus=vd7m6c&startCreateTime=2023-09-27 17:34:58&endCreateTime=2023-09-27 17:34:58&startProcessCreateTime=2023-09-27 17:34:58&endProcessCreateTime=2023-09-27 17:34:58&problemType=dkujnr&functionId=755&directorUserId=434&commonFlag=0&createUserId=275&level=gfal2s&replyStatus=858279&pageFlag=0&urgentFlag=0&opsAdmin=263&orders[0].asc=true&orders[0].column=clxk4w

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "9om344",
      "defaultMsg": "twcijz",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "57h4dc",
      "defaultMsg": "lwqjfs",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "cfy38c",
      "defaultMsg": "7jcg1p",
      "context": {
        "object": "any object"
      }
    }
  ]
}

45.11.查询时间段内的问题类型统计

Type: GET

Author: Lemon

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

Description: 查询时间段内的问题类型统计

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

current

int32

页码，默认为1

false

-

size

int32

页大小，默认为10

false

-

keyword

string

搜索关键字

false

-

idSet

object

ID

false

-

orders

array

排序

false

-

└─column

string

属性名称

false

-

└─asc

boolean

是否升序

false

-

id

int64

No comments found.

false

-

remark

string

No comments found.

false

-

loginUserId

int64

登录用户id 用于数据权限

false

-

createTimeStart

string

No comments found.

false

-

createTimeEnd

string

No comments found.

false

-

modifyUserId

int64

No comments found.

false

-

modifyTimeStart

string

No comments found.

false

-

modifyTimeEnd

string

No comments found.

false

-

dataPermissionFlag

boolean

No comments found.

false

-

feedbackTitle

string

No comments found.

false

-

feedbackStatus

string

No comments found.

false

-

startCreateTime

string

No comments found.

false

-

endCreateTime

string

No comments found.

false

-

startProcessCreateTime

string

No comments found.

false

-

endProcessCreateTime

string

No comments found.

false

-

problemType

string

No comments found.

false

-

functionId

int64

No comments found.

false

-

directorUserId

int64

No comments found.

false

-

commonFlag

int32

No comments found.

false

-

createUserId

int64

No comments found.

false

-

level

string

No comments found.

false

-

replyStatus

string

No comments found.

false

-

pageFlag

int32

No comments found.

false

-

urgentFlag

int32

加急标识，0：不加急，1：加急

false

-

opsAdmin

int64

运维管理员用户id

false

-

Request-example:

curl -X GET -H 'Authorization' -i /API_SYSTEM/problemFeedback/statisticalGroupByProblemType?current=681&size=10&keyword=1hwyhc&column=2wuxw0&asc=true&id=341&remark=e8d8za&loginUserId=509&createTimeStart=2023-09-27 17:34:59&createTimeEnd=2023-09-27 17:34:59&modifyUserId=723&modifyTimeStart=2023-09-27 17:34:59&modifyTimeEnd=2023-09-27 17:34:59&dataPermissionFlag=true&feedbackTitle=bf4f8j&feedbackStatus=5jjm90&startCreateTime=2023-09-27 17:34:59&endCreateTime=2023-09-27 17:34:59&startProcessCreateTime=2023-09-27 17:34:59&endProcessCreateTime=2023-09-27 17:34:59&problemType=fc1csr&functionId=489&directorUserId=463&commonFlag=0&createUserId=293&level=m8snr7&replyStatus=0d1i81&pageFlag=0&urgentFlag=0&opsAdmin=975&orders[0].column=ahwgoi&orders[0].asc=true

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "b8cjo6",
      "defaultMsg": "baw720",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "a4ub4u",
      "defaultMsg": "wilem4",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "cm9ct6",
      "defaultMsg": "3k3a8k",
      "context": {
        "object": "any object"
      }
    }
  ]
}

45.12.查询时间段内的问题所属功能统计

Type: GET

Author: Lemon

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

Description: 查询时间段内的问题所属功能统计

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

current

int32

页码，默认为1

false

-

size

int32

页大小，默认为10

false

-

keyword

string

搜索关键字

false

-

idSet

object

ID

false

-

orders

array

排序

false

-

└─column

string

属性名称

false

-

└─asc

boolean

是否升序

false

-

id

int64

No comments found.

false

-

remark

string

No comments found.

false

-

loginUserId

int64

登录用户id 用于数据权限

false

-

createTimeStart

string

No comments found.

false

-

createTimeEnd

string

No comments found.

false

-

modifyUserId

int64

No comments found.

false

-

modifyTimeStart

string

No comments found.

false

-

modifyTimeEnd

string

No comments found.

false

-

dataPermissionFlag

boolean

No comments found.

false

-

feedbackTitle

string

No comments found.

false

-

feedbackStatus

string

No comments found.

false

-

startCreateTime

string

No comments found.

false

-

endCreateTime

string

No comments found.

false

-

startProcessCreateTime

string

No comments found.

false

-

endProcessCreateTime

string

No comments found.

false

-

problemType

string

No comments found.

false

-

functionId

int64

No comments found.

false

-

directorUserId

int64

No comments found.

false

-

commonFlag

int32

No comments found.

false

-

createUserId

int64

No comments found.

false

-

level

string

No comments found.

false

-

replyStatus

string

No comments found.

false

-

pageFlag

int32

No comments found.

false

-

urgentFlag

int32

加急标识，0：不加急，1：加急

false

-

opsAdmin

int64

运维管理员用户id

false

-

Request-example:

curl -X GET -H 'Authorization' -i /API_SYSTEM/problemFeedback/statisticalGroupByFunctionId?current=564&size=10&keyword=im62is&column=ji0400&asc=true&id=8&remark=s5i6b7&loginUserId=913&createTimeStart=2023-09-27 17:34:59&createTimeEnd=2023-09-27 17:34:59&modifyUserId=322&modifyTimeStart=2023-09-27 17:34:59&modifyTimeEnd=2023-09-27 17:34:59&dataPermissionFlag=true&feedbackTitle=ekogjp&feedbackStatus=u1i78c&startCreateTime=2023-09-27 17:34:59&endCreateTime=2023-09-27 17:34:59&startProcessCreateTime=2023-09-27 17:34:59&endProcessCreateTime=2023-09-27 17:34:59&problemType=dru71f&functionId=744&directorUserId=708&commonFlag=0&createUserId=872&level=gkl43g&replyStatus=nq53rt&pageFlag=0&urgentFlag=0&opsAdmin=377&orders[0].column=6jlfy9&orders[0].asc=true

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "ja1oap",
      "defaultMsg": "z3awno",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "fszueq",
      "defaultMsg": "hvdqxi",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "0zmy60",
      "defaultMsg": "2zecm5",
      "context": {
        "object": "any object"
      }
    }
  ]
}

46.系统功能数据权限项

46.1.新建

Type: POST

Author: wangding

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

Description: 新建

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

id

int64

No comments found.

false

-

remark

string

No comments found.

false

-

createUserId

int64

No comments found.

false

-

creator

string

记录创建者

false

-

createTime

string

No comments found.

false

-

modifyUserId

int64

No comments found.

false

-

modifyTime

string

No comments found.

false

-

deleteFlag

int32

No comments found.

false

-

ignoreWarning

boolean

No comments found.

false

-

nullFields

array

No comments found.

false

-

changeLogId

int64

No comments found.

false

-

functionId

int64

No comments found.

false

-

functionPermissionType

int32

No comments found.

false

-

functionFieldName

string

No comments found.

false

-

functionDataName

string

No comments found.

false

-

functionDataRoles

string

No comments found.

false

-

functionDataType

int32

No comments found.

false

-

Request-example:

curl -X POST -H 'Authorization' -i /EdpWebUtil.APP_API+/system/function/data/insert --data 'id=864&remark=sxcyvk&createUserId=882&creator=wguos4&createTime=2023-09-27 17:34:59&modifyUserId=328&modifyTime=2023-09-27 17:34:59&deleteFlag=0&ignoreWarning=true&nullFields=xyno66,xyno66&changeLogId=644&functionId=923&functionPermissionType=442&functionFieldName=gil.paucek&functionDataName=gil.paucek&functionDataRoles=40jpcz&functionDataType=181'

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "5lnjmm",
      "defaultMsg": "ylhqu7",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "ux8vg4",
      "defaultMsg": "1jfom3",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "3wa025",
      "defaultMsg": "5xjten",
      "context": {
        "object": "any object"
      }
    }
  ]
}

46.2.分页查询

Type: GET

Author: wangding

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

Description: 分页查询

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

current

int32

页码，默认为1

false

-

size

int32

页大小，默认为10

false

-

keyword

string

搜索关键字

false

-

idSet

object

ID

false

-

orders

array

排序

false

-

└─column

string

属性名称

false

-

└─asc

boolean

是否升序

false

-

id

int64

No comments found.

false

-

remark

string

No comments found.

false

-

createUserId

int64

No comments found.

false

-

loginUserId

int64

登录用户id 用于数据权限

false

-

createTimeStart

string

No comments found.

false

-

createTimeEnd

string

No comments found.

false

-

modifyUserId

int64

No comments found.

false

-

modifyTimeStart

string

No comments found.

false

-

modifyTimeEnd

string

No comments found.

false

-

dataPermissionFlag

boolean

No comments found.

false

-

functionId

int64

No comments found.

false

-

functionPermissionType

int32

No comments found.

false

-

functionFieldName

string

No comments found.

false

-

functionDataName

string

No comments found.

false

-

functionDataRoles

string

No comments found.

false

-

functionDataType

int32

No comments found.

false

-

Request-example:

curl -X GET -H 'Authorization' -i /EdpWebUtil.APP_API+/system/function/data/paging?current=378&size=10&keyword=9kr8hc&column=lc1gjv&asc=true&id=27&remark=s0qexa&createUserId=143&loginUserId=616&createTimeStart=2023-09-27 17:34:59&createTimeEnd=2023-09-27 17:34:59&modifyUserId=486&modifyTimeStart=2023-09-27 17:34:59&modifyTimeEnd=2023-09-27 17:34:59&dataPermissionFlag=true&functionId=982&functionPermissionType=770&functionFieldName=gil.paucek&functionDataName=gil.paucek&functionDataRoles=xkhvsf&functionDataType=46&orders[0].asc=true&orders[0].column=4saxcm

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "dd0r59",
      "defaultMsg": "6jv3o1",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "xrrb2k",
      "defaultMsg": "cpgv9z",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "62kpt6",
      "defaultMsg": "he1awe",
      "context": {
        "object": "any object"
      }
    }
  ]
}

46.3.物理删除

Type: DELETE

Author: wangding

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

Description: 物理删除

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

keys

array

主键,[array of int64]

false

-

Request-example:

curl -X DELETE -H 'Authorization' -i /EdpWebUtil.APP_API+/system/function/data/delete?keys=qa9tua&keys=qa9tua

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "d69vo4",
      "defaultMsg": "qw2tkr",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "53gph8",
      "defaultMsg": "hvlsb6",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "ri8h2u",
      "defaultMsg": "mudmef",
      "context": {
        "object": "any object"
      }
    }
  ]
}

46.4.全部修改

Type: PUT

Author: wangding

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

Description: 全部修改

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

id

int64

No comments found.

false

-

remark

string

No comments found.

false

-

createUserId

int64

No comments found.

false

-

creator

string

记录创建者

false

-

createTime

string

No comments found.

false

-

modifyUserId

int64

No comments found.

false

-

modifyTime

string

No comments found.

false

-

deleteFlag

int32

No comments found.

false

-

ignoreWarning

boolean

No comments found.

false

-

nullFields

array

No comments found.

false

-

changeLogId

int64

No comments found.

false

-

functionId

int64

No comments found.

false

-

functionPermissionType

int32

No comments found.

false

-

functionFieldName

string

No comments found.

false

-

functionDataName

string

No comments found.

false

-

functionDataRoles

string

No comments found.

false

-

functionDataType

int32

No comments found.

false

-

Request-example:

curl -X PUT -H 'Authorization' -i /EdpWebUtil.APP_API+/system/function/data/update --data 'id=949&remark=0hbpq4&createUserId=874&creator=ex8bjs&createTime=2023-09-27 17:34:59&modifyUserId=998&modifyTime=2023-09-27 17:34:59&deleteFlag=0&ignoreWarning=true&nullFields=btl9dn,btl9dn&changeLogId=848&functionId=286&functionPermissionType=557&functionFieldName=gil.paucek&functionDataName=gil.paucek&functionDataRoles=3wai4x&functionDataType=171'

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "p3rhym",
      "defaultMsg": "fiflo5",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "nwby76",
      "defaultMsg": "sa59w3",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "lmre4o",
      "defaultMsg": "nqphab",
      "context": {
        "object": "any object"
      }
    }
  ]
}

46.5.根据主键查询

Type: GET

Author: wangding

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

Description: 根据主键查询

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Path-parameters:

ParameterTypeDescriptionRequiredSince

key

int64

主键

true

-

Request-example:

curl -X GET -H 'Authorization' -i /EdpWebUtil.APP_API+/system/function/data/253

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "qialc4",
      "defaultMsg": "81e1hf",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "jw9phu",
      "defaultMsg": "69ruge",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "8etwjf",
      "defaultMsg": "wy66vy",
      "context": {
        "object": "any object"
      }
    }
  ]
}

47.菜单管理

47.1.新建

Type: POST

Author: wangding

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

Description: 新建

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

id

int64

No comments found.

false

-

remark

string

No comments found.

false

-

createUserId

int64

No comments found.

false

-

creator

string

记录创建者

false

-

createTime

string

No comments found.

false

-

modifyUserId

int64

No comments found.

false

-

modifyTime

string

No comments found.

false

-

deleteFlag

int32

No comments found.

false

-

ignoreWarning

boolean

No comments found.

false

-

nullFields

array

No comments found.

false

-

changeLogId

int64

No comments found.

false

-

parentId

int64

No comments found.

false

-

menuCode

string

No comments found.

false

-

menuName

string

No comments found.

false

-

portalRoute

string

No comments found.

false

-

menuIcon

string

No comments found.

false

-

sortIndex

int32

No comments found.

false

-

menuStatus

int32

No comments found.

false

-

Request-example:

curl -X POST -H 'Authorization' -i /api/system/menu/insert --data 'id=705&remark=5c8cok&createUserId=252&creator=lurtla&createTime=2023-09-27 17:34:59&modifyUserId=579&modifyTime=2023-09-27 17:34:59&deleteFlag=0&ignoreWarning=true&nullFields=qyd20l,qyd20l&changeLogId=148&parentId=45&menuCode=88129&menuName=gil.paucek&portalRoute=ypzwkm&menuIcon=e1zvjo&sortIndex=1&menuStatus=28'

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "uf97b9",
      "defaultMsg": "gjx9ge",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "87aj6h",
      "defaultMsg": "lp595a",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "hqvk3q",
      "defaultMsg": "8e5yip",
      "context": {
        "object": "any object"
      }
    }
  ]
}

47.2.状态修改

Type: PUT

Author: wangding

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

Description: 状态修改

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

id

int64

主键 menuStatus 状态

false

-

menuStatus

int32

No comments found.

false

-

Request-example:

curl -X PUT -H 'Authorization' -i /api/system/menu/updateStatus --data 'id=962&menuStatus=264'

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "dub291",
      "defaultMsg": "qk9vmf",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "ksp6o0",
      "defaultMsg": "87tcj8",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "s88x8g",
      "defaultMsg": "90vvtj",
      "context": {
        "object": "any object"
      }
    }
  ]
}

47.3.修改

Type: PUT

Author: wangding

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

Description: 修改

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

id

int64

No comments found.

false

-

remark

string

No comments found.

false

-

createUserId

int64

No comments found.

false

-

creator

string

记录创建者

false

-

createTime

string

No comments found.

false

-

modifyUserId

int64

No comments found.

false

-

modifyTime

string

No comments found.

false

-

deleteFlag

int32

No comments found.

false

-

ignoreWarning

boolean

No comments found.

false

-

nullFields

array

No comments found.

false

-

changeLogId

int64

No comments found.

false

-

parentId

int64

No comments found.

false

-

menuCode

string

No comments found.

false

-

menuName

string

No comments found.

false

-

portalRoute

string

No comments found.

false

-

menuIcon

string

No comments found.

false

-

sortIndex

int32

No comments found.

false

-

menuStatus

int32

No comments found.

false

-

Request-example:

curl -X PUT -H 'Authorization' -i /api/system/menu/update --data 'id=725&remark=51jzo7&createUserId=925&creator=b49q91&createTime=2023-09-27 17:34:59&modifyUserId=736&modifyTime=2023-09-27 17:34:59&deleteFlag=0&ignoreWarning=true&nullFields=ttltst,ttltst&changeLogId=358&parentId=660&menuCode=88129&menuName=gil.paucek&portalRoute=zrc0m4&menuIcon=liahdy&sortIndex=1&menuStatus=861'

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "h575ts",
      "defaultMsg": "vs141w",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "g82lzl",
      "defaultMsg": "nwn27n",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "sftgi8",
      "defaultMsg": "4qsnh3",
      "context": {
        "object": "any object"
      }
    }
  ]
}

47.4.物理删除

Type: DELETE

Author: wangding

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

Description: 物理删除

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Path-parameters:

ParameterTypeDescriptionRequiredSince

key

int64

主键

true

-

Request-example:

curl -X DELETE -H 'Authorization' -i /api/system/menu/delete/679

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "8xx9ii",
      "defaultMsg": "fp35pu",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "donv9s",
      "defaultMsg": "7n907f",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "zdz7fh",
      "defaultMsg": "ejonfa",
      "context": {
        "object": "any object"
      }
    }
  ]
}

47.5.逻辑删除

Type: DELETE

Author: wangding

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

Description: 逻辑删除

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Path-parameters:

ParameterTypeDescriptionRequiredSince

key

int64

主键

true

-

Request-example:

curl -X DELETE -H 'Authorization' -i /api/system/menu/deleteSoft/378

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "xd54ek",
      "defaultMsg": "cmcn46",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "ejx8fw",
      "defaultMsg": "pgqlpu",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "yq7gyq",
      "defaultMsg": "lzubum",
      "context": {
        "object": "any object"
      }
    }
  ]
}

47.6.根据主键查询

Type: GET

Author: wangding

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

Description: 根据主键查询

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Path-parameters:

ParameterTypeDescriptionRequiredSince

key

int64

主键

true

-

Request-example:

curl -X GET -H 'Authorization' -i /api/system/menu/857

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "50s4zp",
      "defaultMsg": "oc1zgk",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "fbqy3x",
      "defaultMsg": "9pe613",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "eq20mu",
      "defaultMsg": "vdass2",
      "context": {
        "object": "any object"
      }
    }
  ]
}

47.7.列表查询

Type: GET

Author: wangding

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

Description: 列表查询

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Request-example:

curl -X GET -H 'Authorization' -i /api/system/menu/list

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "r52csp",
      "defaultMsg": "njwvc9",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "vf6bwl",
      "defaultMsg": "njcw7g",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "ojzi9b",
      "defaultMsg": "ug22rs",
      "context": {
        "object": "any object"
      }
    }
  ]
}

47.8.可用菜单查询

Type: GET

Author: wangding

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

Description: 可用菜单查询

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Request-example:

curl -X GET -H 'Authorization' -i /api/system/menu/usableList

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "4o6xtq",
      "defaultMsg": "rhkw2q",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "xbh2pa",
      "defaultMsg": "4jsqsk",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "wnw99x",
      "defaultMsg": "kjoglg",
      "context": {
        "object": "any object"
      }
    }
  ]
}

48.

48.1.新建

Type: POST

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

Description: 新建

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

id

int64

No comments found.

false

-

remark

string

No comments found.

false

-

createUserId

int64

No comments found.

false

-

creator

string

记录创建者

false

-

createTime

string

No comments found.

false

-

modifyUserId

int64

No comments found.

false

-

modifyTime

string

No comments found.

false

-

deleteFlag

int32

No comments found.

false

-

ignoreWarning

boolean

No comments found.

false

-

nullFields

array

No comments found.

false

-

changeLogId

int64

No comments found.

false

-

assignmentNo

string

指派编号

false

-

assignmentName

string

名称

false

-

priority

string

优先级

false

-

assignUserId

int64

指派人

false

-

assistUserIds

string

协助人

false

-

assignmentType

string

类型

false

-

startDate

string

开始日期

false

-

finishDate

string

完成日期

false

-

assignmentStatus

string

状态

false

-

actualStartDate

string

实际开始日期

false

-

actualFinishDate

string

实际完成日期

false

-

taskId

int64

任务id

false

-

finishUserId

int64

完成人

false

-

progress

int32

进度

false

-

assignmentDesc

string

任务描述

false

-

fileCodes

string

附件

false

-

parentId

int64

父id

false

-

Request-example:

curl -X POST -H 'Authorization' -i /api/work/assignment/insert --data 'id=957&remark=biofhu&createUserId=559&creator=p3l9t1&createTime=2023-09-27 17:34:59&modifyUserId=689&modifyTime=2023-09-27 17:34:59&deleteFlag=0&ignoreWarning=true&nullFields=1oxq40,1oxq40&changeLogId=723&assignmentNo=35wvcl&assignmentName=gil.paucek&priority=s7j5na&assignUserId=37&assistUserIds=89&assignmentType=jsc27i&startDate=2023-09-27&finishDate=2023-09-27&assignmentStatus=noaqzn&actualStartDate=2023-09-27&actualFinishDate=2023-09-27&taskId=637&finishUserId=945&progress=65&assignmentDesc=kd1qil&fileCodes=nf2cqf&parentId=689'

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "n348vg",
      "defaultMsg": "8swpgi",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "dif9pd",
      "defaultMsg": "bwt264",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "ym2usl",
      "defaultMsg": "boe0r7",
      "context": {
        "object": "any object"
      }
    }
  ]
}

48.2.根据主键动态修改

Type: PUT

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

Description: 根据主键动态修改

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

id

int64

No comments found.

false

-

remark

string

No comments found.

false

-

createUserId

int64

No comments found.

false

-

creator

string

记录创建者

false

-

createTime

string

No comments found.

false

-

modifyUserId

int64

No comments found.

false

-

modifyTime

string

No comments found.

false

-

deleteFlag

int32

No comments found.

false

-

ignoreWarning

boolean

No comments found.

false

-

nullFields

array

No comments found.

false

-

changeLogId

int64

No comments found.

false

-

assignmentNo

string

指派编号

false

-

assignmentName

string

名称

false

-

priority

string

优先级

false

-

assignUserId

int64

指派人

false

-

assistUserIds

string

协助人

false

-

assignmentType

string

类型

false

-

startDate

string

开始日期

false

-

finishDate

string

完成日期

false

-

assignmentStatus

string

状态

false

-

actualStartDate

string

实际开始日期

false

-

actualFinishDate

string

实际完成日期

false

-

taskId

int64

任务id

false

-

finishUserId

int64

完成人

false

-

progress

int32

进度

false

-

assignmentDesc

string

任务描述

false

-

fileCodes

string

附件

false

-

parentId

int64

父id

false

-

Request-example:

curl -X PUT -H 'Authorization' -i /api/work/assignment/updateByKeyDynamic --data 'id=848&remark=gw9qnq&createUserId=296&creator=8d66rx&createTime=2023-09-27 17:34:59&modifyUserId=590&modifyTime=2023-09-27 17:34:59&deleteFlag=0&ignoreWarning=true&nullFields=5j69y3,5j69y3&changeLogId=935&assignmentNo=93abqg&assignmentName=gil.paucek&priority=jyvbmw&assignUserId=23&assistUserIds=89&assignmentType=2k2lwy&startDate=2023-09-27&finishDate=2023-09-27&assignmentStatus=b4fnx7&actualStartDate=2023-09-27&actualFinishDate=2023-09-27&taskId=302&finishUserId=414&progress=951&assignmentDesc=qeeeds&fileCodes=7sjhmr&parentId=49'

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "9xb868",
      "defaultMsg": "sc29v1",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "si49rr",
      "defaultMsg": "soep68",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "30x93q",
      "defaultMsg": "5rqljp",
      "context": {
        "object": "any object"
      }
    }
  ]
}

48.3.分页查询

Type: GET

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

Description: 分页查询

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

current

int32

页码，默认为1

false

-

size

int32

页大小，默认为10

false

-

keyword

string

搜索关键字

false

-

idSet

object

ID

false

-

orders

array

排序

false

-

└─column

string

属性名称

false

-

└─asc

boolean

是否升序

false

-

id

int64

No comments found.

false

-

remark

string

No comments found.

false

-

createUserId

int64

No comments found.

false

-

loginUserId

int64

登录用户id 用于数据权限

false

-

createTimeStart

string

No comments found.

false

-

createTimeEnd

string

No comments found.

false

-

modifyUserId

int64

No comments found.

false

-

modifyTimeStart

string

No comments found.

false

-

modifyTimeEnd

string

No comments found.

false

-

dataPermissionFlag

boolean

No comments found.

false

-

assignmentNo

string

指派编号

false

-

assignmentName

string

名称

false

-

priority

string

优先级

false

-

assignUserId

int64

指派人

false

-

assistUserIds

string

协助人

false

-

assignmentType

string

类型

false

-

startDate

string

开始日期

false

-

endDate

string

完成日期

false

-

assignmentStatus

string

状态

false

-

assignmentStatusList

array

状态

false

-

actualStartDate

string

实际开始日期

false

-

actualFinishDate

string

实际完成日期

false

-

taskId

int64

任务id

false

-

finishUserId

int64

完成人

false

-

progress

int32

进度

false

-

assignmentDesc

string

任务描述

false

-

fileCodes

string

附件

false

-

parentId

int64

父id

false

-

participantUserId

int64

参与用户id

false

-

searchStartDate

string

开始日期查询

false

-

searchEndDate

string

结束日期查询

false

-

empUserId

int64

员工userId

false

-

orgId

int64

组织id

false

-

Request-example:

curl -X GET -H 'Authorization' -i /api/work/assignment/paging?current=296&size=10&keyword=ek2gmm&column=wn7443&asc=true&id=128&remark=745zkv&createUserId=758&loginUserId=600&createTimeStart=2023-09-27 17:34:59&createTimeEnd=2023-09-27 17:34:59&modifyUserId=552&modifyTimeStart=2023-09-27 17:34:59&modifyTimeEnd=2023-09-27 17:34:59&dataPermissionFlag=true&assignmentNo=hkvnu3&assignmentName=gil.paucek&priority=mk5ykv&assignUserId=550&assistUserIds=89&assignmentType=77e3oh&startDate=2023-09-27&endDate=2023-09-27&assignmentStatus=tnccqb&assignmentStatusList=o6wokw,o6wokw&actualStartDate=2023-09-27&actualFinishDate=2023-09-27&taskId=131&finishUserId=985&progress=353&assignmentDesc=dqcplp&fileCodes=zd456o&parentId=788&participantUserId=449&searchStartDate=2023-09-27&searchEndDate=2023-09-27&empUserId=695&orgId=351&orders[0].column=3y3mmw&orders[0].asc=true

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "pkuq9o",
      "defaultMsg": "5wgx8v",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "t0igwe",
      "defaultMsg": "xsc3i2",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "e2dqih",
      "defaultMsg": "pvbf2i",
      "context": {
        "object": "any object"
      }
    }
  ]
}

48.4.主键查询

Type: GET

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

Description: 主键查询

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Path-parameters:

ParameterTypeDescriptionRequiredSince

key

int64

主键

true

-

Request-example:

curl -X GET -H 'Authorization' -i /api/work/assignment/790

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "hmshcf",
      "defaultMsg": "rhvi3h",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "ghypxh",
      "defaultMsg": "2enoks",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "t5qixa",
      "defaultMsg": "dqh2hu",
      "context": {
        "object": "any object"
      }
    }
  ]
}

48.5.开始

Type: PUT

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

Description: 开始

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

ids

array

主键,[array of int64]

false

-

Request-example:

curl -X PUT -H 'Authorization' -i /api/work/assignment/start --data 'ids=vc77kg&ids=vc77kg'

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "k9yoqk",
      "defaultMsg": "ru7xnr",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "pwxcuw",
      "defaultMsg": "kfleet",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "g8scbd",
      "defaultMsg": "5bj55a",
      "context": {
        "object": "any object"
      }
    }
  ]
}

48.6.暂挂

Type: PUT

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

Description: 暂挂

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

ids

array

主键,[array of int64]

false

-

Request-example:

curl -X PUT -H 'Authorization' -i /api/work/assignment/pending --data 'ids=spiz02&ids=spiz02'

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "efjl41",
      "defaultMsg": "rn4wt1",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "vvg7ek",
      "defaultMsg": "1svipo",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "dll1js",
      "defaultMsg": "ursbt0",
      "context": {
        "object": "any object"
      }
    }
  ]
}

48.7.完成

Type: PUT

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

Description: 完成

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

ids

array

主键,[array of int64]

false

-

Request-example:

curl -X PUT -H 'Authorization' -i /api/work/assignment/finish --data 'ids=q0pzpi&ids=q0pzpi'

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "tgldj6",
      "defaultMsg": "ttc3t6",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "ugmm95",
      "defaultMsg": "47vpir",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "eox3nb",
      "defaultMsg": "atkpjh",
      "context": {
        "object": "any object"
      }
    }
  ]
}

48.8.关闭

Type: PUT

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

Description: 关闭

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

ids

array

主键,[array of int64]

false

-

Request-example:

curl -X PUT -H 'Authorization' -i /api/work/assignment/close --data 'ids=k0me0x&ids=k0me0x'

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "53fzms",
      "defaultMsg": "gkb60o",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "27ltww",
      "defaultMsg": "juz7wy",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "p354lu",
      "defaultMsg": "0qxv9v",
      "context": {
        "object": "any object"
      }
    }
  ]
}

48.9.列表查询

Type: GET

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

Description: 列表查询

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

current

int32

页码，默认为1

false

-

size

int32

页大小，默认为10

false

-

keyword

string

搜索关键字

false

-

idSet

object

ID

false

-

orders

array

排序

false

-

└─column

string

属性名称

false

-

└─asc

boolean

是否升序

false

-

id

int64

No comments found.

false

-

remark

string

No comments found.

false

-

createUserId

int64

No comments found.

false

-

loginUserId

int64

登录用户id 用于数据权限

false

-

createTimeStart

string

No comments found.

false

-

createTimeEnd

string

No comments found.

false

-

modifyUserId

int64

No comments found.

false

-

modifyTimeStart

string

No comments found.

false

-

modifyTimeEnd

string

No comments found.

false

-

dataPermissionFlag

boolean

No comments found.

false

-

assignmentNo

string

指派编号

false

-

assignmentName

string

名称

false

-

priority

string

优先级

false

-

assignUserId

int64

指派人

false

-

assistUserIds

string

协助人

false

-

assignmentType

string

类型

false

-

startDate

string

开始日期

false

-

endDate

string

完成日期

false

-

assignmentStatus

string

状态

false

-

assignmentStatusList

array

状态

false

-

actualStartDate

string

实际开始日期

false

-

actualFinishDate

string

实际完成日期

false

-

taskId

int64

任务id

false

-

finishUserId

int64

完成人

false

-

progress

int32

进度

false

-

assignmentDesc

string

任务描述

false

-

fileCodes

string

附件

false

-

parentId

int64

父id

false

-

participantUserId

int64

参与用户id

false

-

searchStartDate

string

开始日期查询

false

-

searchEndDate

string

结束日期查询

false

-

empUserId

int64

员工userId

false

-

orgId

int64

组织id

false

-

Request-example:

curl -X GET -H 'Authorization' -i /api/work/assignment/queryList?current=746&size=10&keyword=b90fym&column=a2vjho&asc=true&id=917&remark=dqlpbl&createUserId=419&loginUserId=222&createTimeStart=2023-09-27 17:34:59&createTimeEnd=2023-09-27 17:34:59&modifyUserId=172&modifyTimeStart=2023-09-27 17:34:59&modifyTimeEnd=2023-09-27 17:34:59&dataPermissionFlag=true&assignmentNo=0p0kvf&assignmentName=gil.paucek&priority=7nvqqe&assignUserId=6&assistUserIds=89&assignmentType=gx5uob&startDate=2023-09-27&endDate=2023-09-27&assignmentStatus=uib0sa&assignmentStatusList=kuxou7,kuxou7&actualStartDate=2023-09-27&actualFinishDate=2023-09-27&taskId=273&finishUserId=911&progress=224&assignmentDesc=dr5zqi&fileCodes=nvb1qj&parentId=517&participantUserId=503&searchStartDate=2023-09-27&searchEndDate=2023-09-27&empUserId=338&orgId=708&orders[0].column=oypu02&orders[0].asc=true

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "wp8rwc",
      "defaultMsg": "zdwvzs",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "zrkevj",
      "defaultMsg": "wslpmw",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "57ogim",
      "defaultMsg": "p9zrqe",
      "context": {
        "object": "any object"
      }
    }
  ]
}

48.10.逻辑删除

Type: DELETE

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

Description: 逻辑删除

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

keys

array

主键,[array of int64]

false

-

Request-example:

curl -X DELETE -H 'Authorization' -i /api/work/assignment/deleteSoft?keys=a50naz&keys=a50naz

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "92924x",
      "defaultMsg": "3mogkj",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "0dlq3w",
      "defaultMsg": "eipnpm",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "6pwch6",
      "defaultMsg": "9wtlfv",
      "context": {
        "object": "any object"
      }
    }
  ]
}

49.

49.1.新建

Type: POST

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

Description: 新建

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

id

int64

No comments found.

false

-

remark

string

No comments found.

false

-

createUserId

int64

No comments found.

false

-

creator

string

记录创建者

false

-

createTime

string

No comments found.

false

-

modifyUserId

int64

No comments found.

false

-

modifyTime

string

No comments found.

false

-

deleteFlag

int32

No comments found.

false

-

ignoreWarning

boolean

No comments found.

false

-

nullFields

array

No comments found.

false

-

changeLogId

int64

No comments found.

false

-

assignmentId

int64

指派id

false

-

operationAction

string

操作动作

false

-

operationTitle

string

操作记录

false

-

Request-example:

curl -X POST -H 'Authorization' -i /api/work/assignmentHistory/insert --data 'id=282&remark=gh49g5&createUserId=400&creator=427cug&createTime=2023-09-27 17:34:59&modifyUserId=403&modifyTime=2023-09-27 17:34:59&deleteFlag=0&ignoreWarning=true&nullFields=m63wta,m63wta&changeLogId=653&assignmentId=15&operationAction=i8h8f4&operationTitle=93z5u9'

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "3l939r",
      "defaultMsg": "poaldx",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "tmp3mq",
      "defaultMsg": "glp4oq",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "b6u96x",
      "defaultMsg": "8gez6n",
      "context": {
        "object": "any object"
      }
    }
  ]
}

49.2.全部修改

Type: PUT

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

Description: 全部修改

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

id

int64

No comments found.

false

-

remark

string

No comments found.

false

-

createUserId

int64

No comments found.

false

-

creator

string

记录创建者

false

-

createTime

string

No comments found.

false

-

modifyUserId

int64

No comments found.

false

-

modifyTime

string

No comments found.

false

-

deleteFlag

int32

No comments found.

false

-

ignoreWarning

boolean

No comments found.

false

-

nullFields

array

No comments found.

false

-

changeLogId

int64

No comments found.

false

-

assignmentId

int64

指派id

false

-

operationAction

string

操作动作

false

-

operationTitle

string

操作记录

false

-

Request-example:

curl -X PUT -H 'Authorization' -i /api/work/assignmentHistory/update --data 'id=111&remark=c20rm8&createUserId=145&creator=e5r4gj&createTime=2023-09-27 17:34:59&modifyUserId=175&modifyTime=2023-09-27 17:34:59&deleteFlag=0&ignoreWarning=true&nullFields=6apyp8,6apyp8&changeLogId=29&assignmentId=333&operationAction=otux56&operationTitle=s05gny'

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "ao98fm",
      "defaultMsg": "50apxa",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "l609ko",
      "defaultMsg": "6l0pgc",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "wgsu8v",
      "defaultMsg": "46abvu",
      "context": {
        "object": "any object"
      }
    }
  ]
}

50.

50.1.动态指定任务负责人

Type: POST

Author: yangzhibin

Content-Type: application/json

Description: 动态指定任务负责人

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Request-example:

curl -X POST -H 'Content-Type: application/json' -H 'Authorization' -i /WorkflowConstant.WORKFLOWFLOW_DEMOWorkflowConstant.CALLBACK/WorkflowConstant.TASK_ASSIGNEE_PATH --data '{}'

Response-example:

[
  "roianw",
  "kygn50"
]

50.2.任务创建回调

Type: POST

Author: yangzhibin

Content-Type: application/json

Description: 任务创建回调

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Request-example:

curl -X POST -H 'Content-Type: application/json' -H 'Authorization' -i /WorkflowConstant.WORKFLOWFLOW_DEMOWorkflowConstant.CALLBACK/WorkflowConstant.TASK_CREATED_PATH --data '{}'

Response-example:

Return void.

50.3.任务完成回调(只有正常推下一个节点,才算任务完成,其他从当前任务撤回/驳回都能不算当前任务完成,不会触发下面回调)

Type: POST

Author: yangzhibin

Content-Type: application/json

Description: 任务完成回调(只有正常推下一个节点,才算任务完成,其他从当前任务撤回/驳回都能不算当前任务完成,不会触发下面回调)

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Request-example:

curl -X POST -H 'Content-Type: application/json' -H 'Authorization' -i /WorkflowConstant.WORKFLOWFLOW_DEMOWorkflowConstant.CALLBACK/WorkflowConstant.TASK_COMPLETED_PATH --data '{}'

Response-example:

Return void.

50.4.流程状态变化回调

Type: POST

Author: yangzhibin

Content-Type: application/json

Description: 流程状态变化回调

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Request-example:

curl -X POST -H 'Content-Type: application/json' -H 'Authorization' -i /WorkflowConstant.WORKFLOWFLOW_DEMOWorkflowConstant.CALLBACK/WorkflowConstant.PROCESS_STATUS_CHANGE_PATH --data '{}'

Response-example:

Return void.

51.个人管理

51.1.查询个人菜单

Type: GET

Author: wangding

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

Description: 查询个人菜单

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Request-example:

curl -X GET -H 'Authorization' -i /api/my/user/queryMenus

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "7tubhz",
      "defaultMsg": "q2afq2",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "744ijt",
      "defaultMsg": "55lusp",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "5l1je8",
      "defaultMsg": "gwn4gf",
      "context": {
        "object": "any object"
      }
    }
  ]
}

51.2.查询个人复合能力

Type: PUT

Author: wangding

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

Description: 查询个人复合能力

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

userId

int64

No comments found.

false

-

Request-example:

curl -X PUT -H 'Authorization' -i /api/my/user/queryCompositeVO --data 'userId=18'

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "ydotts",
      "defaultMsg": "gjho3k",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "pxawob",
      "defaultMsg": "9witcc",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "snba9p",
      "defaultMsg": "qi38oj",
      "context": {
        "object": "any object"
      }
    }
  ]
}

51.3.查询个人数据

移动端see com.elitesland.tw.tw5.server.prd.app.controller.AppUserController#queryDetailForMobile()

Type: PUT

Author: wangding

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

Description: 查询个人数据

移动端see com.elitesland.tw.tw5.server.prd.app.controller.AppUserController#queryDetailForMobile()

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Request-example:

curl -X PUT -H 'Authorization' -i /api/my/user/queryDetail

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "uuzi26",
      "defaultMsg": "wqqfz6",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "7nqe2v",
      "defaultMsg": "fln7wr",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "7bzi52",
      "defaultMsg": "ux6uss",
      "context": {
        "object": "any object"
      }
    }
  ]
}

51.4.修改密码

Type: GET

Author: wangding

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

Description: 修改密码

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

oldPassword

string

当前密码

false

-

newPassword

string

新密码

false

-

Request-example:

curl -X GET -H 'Authorization' -i /api/my/user/updatePassword?oldPassword=u78v8o&newPassword=lnm7f0

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "9mt6u4",
      "defaultMsg": "0oapld",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "2qchvr",
      "defaultMsg": "itaa4u",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "mtfx5q",
      "defaultMsg": "ox4dyl",
      "context": {
        "object": "any object"
      }
    }
  ]
}

51.5.修改个人快捷入口

Type: PUT

Author: wangding

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

Description: 修改个人快捷入口

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

shortcutIds

string

快捷入口ids(","拼接字符串)

false

-

Request-example:

curl -X PUT -H 'Authorization' -i /api/my/user/updateShortcut --data 'shortcutIds=89'

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "p0d3at",
      "defaultMsg": "k2scq3",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "g27zje",
      "defaultMsg": "k9jyr1",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "n2oli9",
      "defaultMsg": "d0z549",
      "context": {
        "object": "any object"
      }
    }
  ]
}

51.6.查询我的工作代办

Type: GET

Author: wangding

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

Description: 查询我的工作代办

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Request-example:

curl -X GET -H 'Authorization' -i /api/my/user/findMyWork

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "j5lai4",
      "defaultMsg": "krxog2",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "g8m0uz",
      "defaultMsg": "xuvdg1",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "pz7lxq",
      "defaultMsg": "yhz081",
      "context": {
        "object": "any object"
      }
    }
  ]
}

51.7.查询我的提醒

Type: GET

Author: wangding

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

Description: 查询我的提醒

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Request-example:

curl -X GET -H 'Authorization' -i /api/my/user/findMyRemind

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "u1zzm7",
      "defaultMsg": "f5mbh0",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "hv0oap",
      "defaultMsg": "dx7160",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "0a4zrp",
      "defaultMsg": "6qanlr",
      "context": {
        "object": "any object"
      }
    }
  ]
}

51.8.修改我的提醒

Type: GET

Author: wangding

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

Description: 修改我的提醒

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

remindType

string

提醒类型

false

-

Request-example:

curl -X GET -H 'Authorization' -i /api/my/user/updateMyRemind?remindType=4n4ar3

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "x9b2zs",
      "defaultMsg": "vh2hn7",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "y8m5cc",
      "defaultMsg": "q3mem2",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "iviz24",
      "defaultMsg": "w1d00r",
      "context": {
        "object": "any object"
      }
    }
  ]
}

51.9.查询我的所有组织

Type: GET

Author: wangding

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

Description: 查询我的所有组织

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Request-example:

curl -X GET -H 'Authorization' -i /api/my/user/queryOrgList

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "hnais4",
      "defaultMsg": "zwgsij",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "ivaf83",
      "defaultMsg": "fvrtz7",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "ezmxn0",
      "defaultMsg": "5gdk95",
      "context": {
        "object": "any object"
      }
    }
  ]
}

51.10.查询我的所有下级

Type: GET

Author: wangding

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

Description: 查询我的所有下级

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

orgId

int64

组织id

false

-

Request-example:

curl -X GET -H 'Authorization' -i /api/my/user/queryLowList?orgId=450

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "umjwdt",
      "defaultMsg": "219tfi",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "qqu7i9",
      "defaultMsg": "1f46kt",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "r2epej",
      "defaultMsg": "b9oi4g",
      "context": {
        "object": "any object"
      }
    }
  ]
}

51.11.通过ticket获取用户数据
接口作用：
1、tw5.0跳转4.0，例如：5.0创建合同跳转至4.0
2、tw4.0校验ticket

Type: POST

Author: wangding

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

Description: 通过ticket获取用户数据
接口作用：
1、tw5.0跳转4.0，例如：5.0创建合同跳转至4.0
2、tw4.0校验ticket

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Request-example:

curl -X POST -H 'Authorization' -i /api/my/user/queryUserByTicket

Response-example:

Return void.

52.个人消息管理

52.1.查询未读消息总数

Type: PUT

Author: wangding

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

Description: 查询未读消息总数

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Request-example:

curl -X PUT -H 'Authorization' -i /api/my/message/queryTotal

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "cqxe45",
      "defaultMsg": "q53ctp",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "a0o5y9",
      "defaultMsg": "1h4rto",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "ypi3g9",
      "defaultMsg": "zsgfmx",
      "context": {
        "object": "any object"
      }
    }
  ]
}

52.2.逻辑删除

Type: DELETE

Author: wangding

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

Description: 逻辑删除

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

keys

array

主键,[array of int64]

false

-

Request-example:

curl -X DELETE -H 'Authorization' -i /api/my/message/deleteSoft?keys=rwnzra&keys=rwnzra

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "asyvy8",
      "defaultMsg": "s2l2zx",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "f31svu",
      "defaultMsg": "r9txxo",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "cnh7xr",
      "defaultMsg": "ilas91",
      "context": {
        "object": "any object"
      }
    }
  ]
}

52.3.根据主键查询

Type: GET

Author: wangding

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

Description: 根据主键查询

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Path-parameters:

ParameterTypeDescriptionRequiredSince

key

int64

主键

true

-

Request-example:

curl -X GET -H 'Authorization' -i /api/my/message/7

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "y6l9ct",
      "defaultMsg": "70q0li",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "zawgx7",
      "defaultMsg": "ypxeqc",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "xnagzt",
      "defaultMsg": "bfn00a",
      "context": {
        "object": "any object"
      }
    }
  ]
}

52.4.分页查询

Type: GET

Author: wangding

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

Description: 分页查询

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

current

int32

页码，默认为1

false

-

size

int32

页大小，默认为10

false

-

keyword

string

搜索关键字

false

-

idSet

object

ID

false

-

orders

array

排序

false

-

└─column

string

属性名称

false

-

└─asc

boolean

是否升序

false

-

id

int64

No comments found.

false

-

remark

string

No comments found.

false

-

createUserId

int64

No comments found.

false

-

loginUserId

int64

登录用户id 用于数据权限

false

-

createTimeStart

string

No comments found.

false

-

createTimeEnd

string

No comments found.

false

-

modifyUserId

int64

No comments found.

false

-

modifyTimeStart

string

No comments found.

false

-

modifyTimeEnd

string

No comments found.

false

-

dataPermissionFlag

boolean

No comments found.

false

-

messageCode

string

消息编号

false

-

messageTitle

string

消息标题

false

-

messageContent

string

消息内容

false

-

contentType

string

消息类别

false

-

contentBigType

string

消息大类

false

-

createSource

string

发布来源， （以谁的名义发布该条消息，默认是个人）

false

-

messageTag

string

消息标签

false

-

messageStatus

int32

No comments found.

false

-

Request-example:

curl -X GET -H 'Authorization' -i /api/my/message/paging?current=559&size=10&keyword=4ubvyp&column=pq2zrd&asc=true&id=458&remark=j3lme9&createUserId=11&loginUserId=104&createTimeStart=2023-09-27 17:34:59&createTimeEnd=2023-09-27 17:34:59&modifyUserId=482&modifyTimeStart=2023-09-27 17:34:59&modifyTimeEnd=2023-09-27 17:34:59&dataPermissionFlag=true&messageCode=88129&messageTitle=d0ls6i&messageContent=yxdx83&contentType=r5q4mu&contentBigType=scnqkj&createSource=iqf335&messageTag=n8ykux&messageStatus=60&orders[0].column=11rmjq&orders[0].asc=true

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "khyqsi",
      "defaultMsg": "dkosqw",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "k61tcz",
      "defaultMsg": "n709lt",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "8fy56i",
      "defaultMsg": "pzudq3",
      "context": {
        "object": "any object"
      }
    }
  ]
}

52.5.一键已读

Type: PUT

Author: wangding

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

Description: 一键已读

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

keys

array

主键,[array of int64]

false

-

Request-example:

curl -X PUT -H 'Authorization' -i /api/my/message/onKeyUpdateStatus --data 'keys=mrorpp&keys=mrorpp'

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "k5dnhd",
      "defaultMsg": "y01cni",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "f02rhe",
      "defaultMsg": "a6bvkr",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "gpgpd5",
      "defaultMsg": "wnacjb",
      "context": {
        "object": "any object"
      }
    }
  ]
}

52.6.查询未读消息类别列表

Type: GET

Author: wangding

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

Description: 查询未读消息类别列表

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Request-example:

curl -X GET -H 'Authorization' -i /api/my/message/findUnreadMessageTypeList

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

array

业务数据

-

└─contentType

string

消息类别

-

└─contentTypeName

string

消息类别名称

-

└─unreadContentCount

int64

未读消息数量

-

└─lastUserMessageVO

object

最新一条消息

-

     └─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

锁版本

-

     └─messageId

int64

消息Id

-

     └─messageCode

string

消息编号

-

     └─messageTitle

string

消息标题

-

     └─messageContent

string

消息内容

-

     └─contentType

string

消息类别

-

     └─contentTypeName

string

消息类别名称

-

     └─contentBigType

string

消息大类

-

     └─contentBigTypeName

string

消息大类名称

-

     └─createSource

string

发布来源， （以谁的名义发布该条消息，默认是个人）

-

     └─messageTag

string

消息标签

-

     └─messageTagName

string

消息标签名称

-

     └─noticeScope

string

通知范围

-

     └─noticeScopeName

string

通知范围名称

-

     └─noticeSource

string

通知范围的关联项，如果选择角色，部门，个人 提交以','分割id或编号

-

     └─noticeSourceName

string

通知范围的关联项，如果选择角色，部门，个人 提交以','分割id或编号

-

     └─messageStatus

int32

消息状态 0新建 1已读

-

     └─objectId

int64

业务数据ID

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": [
    {
      "contentType": "w8b7wj",
      "contentTypeName": "gil.paucek",
      "unreadContentCount": 426,
      "lastUserMessageVO": {
        "id": 515,
        "tenantId": 911,
        "remark": "gxxmf4",
        "createUserId": 715,
        "creator": "jrf9i8",
        "createTime": "2023-09-27 17:34:59",
        "modifyUserId": 560,
        "updater": "7ooqzq",
        "modifyTime": "2023-09-27 17:34:59",
        "deleteFlag": 0,
        "auditDataVersion": 94,
        "messageId": 622,
        "messageCode": "88129",
        "messageTitle": "tb128u",
        "messageContent": "nf1l03",
        "contentType": "x5qd05",
        "contentTypeName": "gil.paucek",
        "contentBigType": "8cvj1l",
        "contentBigTypeName": "gil.paucek",
        "createSource": "pv0zmt",
        "messageTag": "qud5ke",
        "messageTagName": "gil.paucek",
        "noticeScope": "oa10eo",
        "noticeScopeName": "gil.paucek",
        "noticeSource": "hnx5x1",
        "noticeSourceName": "gil.paucek",
        "messageStatus": 807,
        "objectId": 346
      }
    }
  ],
  "infos": [
    {
      "localeCode": "88129",
      "msg": "oli05l",
      "defaultMsg": "mzns72",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "qaoew0",
      "defaultMsg": "ul1zzf",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "jasdjs",
      "defaultMsg": "sjt1ti",
      "context": {
        "object": "any object"
      }
    }
  ]
}

52.7.根据消息类别查询未读消息列表

Type: GET

Author: wangding

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

Description: 根据消息类别查询未读消息列表

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

contentType

string

No comments found.

false

-

Request-example:

curl -X GET -H 'Authorization' -i /api/my/message/findUnreadMessageListByType?contentType=8eg9j0

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

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

锁版本

-

└─messageId

int64

消息Id

-

└─messageCode

string

消息编号

-

└─messageTitle

string

消息标题

-

└─messageContent

string

消息内容

-

└─contentType

string

消息类别

-

└─contentTypeName

string

消息类别名称

-

└─contentBigType

string

消息大类

-

└─contentBigTypeName

string

消息大类名称

-

└─createSource

string

发布来源， （以谁的名义发布该条消息，默认是个人）

-

└─messageTag

string

消息标签

-

└─messageTagName

string

消息标签名称

-

└─noticeScope

string

通知范围

-

└─noticeScopeName

string

通知范围名称

-

└─noticeSource

string

通知范围的关联项，如果选择角色，部门，个人 提交以','分割id或编号

-

└─noticeSourceName

string

通知范围的关联项，如果选择角色，部门，个人 提交以','分割id或编号

-

└─messageStatus

int32

消息状态 0新建 1已读

-

└─objectId

int64

业务数据ID

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": [
    {
      "id": 545,
      "tenantId": 959,
      "remark": "oi70e6",
      "createUserId": 587,
      "creator": "0qayx3",
      "createTime": "2023-09-27 17:34:59",
      "modifyUserId": 416,
      "updater": "mhmrtt",
      "modifyTime": "2023-09-27 17:34:59",
      "deleteFlag": 0,
      "auditDataVersion": 614,
      "messageId": 378,
      "messageCode": "88129",
      "messageTitle": "33jctw",
      "messageContent": "1tkie2",
      "contentType": "hb4yky",
      "contentTypeName": "gil.paucek",
      "contentBigType": "qpvolh",
      "contentBigTypeName": "gil.paucek",
      "createSource": "remmhu",
      "messageTag": "zeuk6d",
      "messageTagName": "gil.paucek",
      "noticeScope": "twyouh",
      "noticeScopeName": "gil.paucek",
      "noticeSource": "d10grw",
      "noticeSourceName": "gil.paucek",
      "messageStatus": 387,
      "objectId": 309
    }
  ],
  "infos": [
    {
      "localeCode": "88129",
      "msg": "8pilt6",
      "defaultMsg": "ywlyw7",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "v0selj",
      "defaultMsg": "0g7wwv",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "qwwqhj",
      "defaultMsg": "ik94bp",
      "context": {
        "object": "any object"
      }
    }
  ]
}

53.短链服务配置

53.1.短链服务配置-新增

Type: POST

Author: duwh

Content-Type: application/json

Description: 短链服务配置-新增

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Body-parameters:

ParameterTypeDescriptionRequiredSince

id

int64

No comments found.

false

-

remark

string

No comments found.

false

-

createUserId

int64

No comments found.

false

-

creator

string

记录创建者

false

-

createTime

string

No comments found.

false

-

modifyUserId

int64

No comments found.

false

-

modifyTime

string

No comments found.

false

-

deleteFlag

int32

No comments found.

false

-

ignoreWarning

boolean

No comments found.

false

-

nullFields

array

No comments found.

false

-

changeLogId

int64

No comments found.

false

-

shortUrlRelative

string

短链地址-相对地址

false

-

shortUrlPre

string

短链地址前缀

false

-

longUrlPre

string

长链地址后缀

false

-

ext1

string

拓展1

false

-

ext2

string

拓展2

false

-

ext3

string

拓展3

false

-

ext4

string

拓展4

false

-

ext5

string

拓展5

false

-

Request-example:

curl -X POST -H 'Content-Type: application/json' -H 'Authorization' -i /api/prd/shortUrlConf --data '{
  "id": 668,
  "remark": "oap36a",
  "createUserId": 75,
  "creator": "cqeq3p",
  "createTime": "2023-09-27 17:34:59",
  "modifyUserId": 932,
  "modifyTime": "2023-09-27 17:34:59",
  "deleteFlag": 0,
  "ignoreWarning": true,
  "nullFields": [
    "kg9hgl"
  ],
  "changeLogId": 725,
  "shortUrlRelative": "cr9pav",
  "shortUrlPre": "xczwh1",
  "longUrlPre": "w1evch",
  "ext1": "0qt5bn",
  "ext2": "zi4ty4",
  "ext3": "9a453y",
  "ext4": "cs3eq9",
  "ext5": "fxkrsx"
}'

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

└─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

锁版本

-

└─shortUrlRelative

string

短链地址-相对地址

-

└─shortUrlPre

string

短链地址前缀

-

└─longUrlPre

string

长链地址后缀

-

└─secTenantId

int64

数据归属租户id

-

└─ext1

string

拓展1

-

└─ext2

string

拓展2

-

└─ext3

string

拓展3

-

└─ext4

string

拓展4

-

└─ext5

string

拓展5

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {
    "id": 52,
    "tenantId": 19,
    "remark": "1xsy4e",
    "createUserId": 586,
    "creator": "zs1r7j",
    "createTime": "2023-09-27 17:34:59",
    "modifyUserId": 374,
    "updater": "ojut05",
    "modifyTime": "2023-09-27 17:34:59",
    "deleteFlag": 0,
    "auditDataVersion": 862,
    "shortUrlRelative": "8mowvv",
    "shortUrlPre": "961arx",
    "longUrlPre": "spsqok",
    "secTenantId": 339,
    "ext1": "m5w5it",
    "ext2": "9j41ll",
    "ext3": "7yo1of",
    "ext4": "k3rxhx",
    "ext5": "d2bszz"
  },
  "infos": [
    {
      "localeCode": "88129",
      "msg": "4m9r2e",
      "defaultMsg": "uhrwsa",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "zec43k",
      "defaultMsg": "fmjvk6",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "nax7n5",
      "defaultMsg": "6lw0p0",
      "context": {
        "object": "any object"
      }
    }
  ]
}

53.2.短链服务配置-更新

Type: PUT

Author: duwh

Content-Type: application/json

Description: 短链服务配置-更新

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Body-parameters:

ParameterTypeDescriptionRequiredSince

id

int64

No comments found.

false

-

remark

string

No comments found.

false

-

createUserId

int64

No comments found.

false

-

creator

string

记录创建者

false

-

createTime

string

No comments found.

false

-

modifyUserId

int64

No comments found.

false

-

modifyTime

string

No comments found.

false

-

deleteFlag

int32

No comments found.

false

-

ignoreWarning

boolean

No comments found.

false

-

nullFields

array

No comments found.

false

-

changeLogId

int64

No comments found.

false

-

shortUrlRelative

string

短链地址-相对地址

false

-

shortUrlPre

string

短链地址前缀

false

-

longUrlPre

string

长链地址后缀

false

-

ext1

string

拓展1

false

-

ext2

string

拓展2

false

-

ext3

string

拓展3

false

-

ext4

string

拓展4

false

-

ext5

string

拓展5

false

-

Request-example:

curl -X PUT -H 'Content-Type: application/json' -H 'Authorization' -i /api/prd/shortUrlConf --data '{
  "id": 832,
  "remark": "z85twe",
  "createUserId": 263,
  "creator": "ixlkl0",
  "createTime": "2023-09-27 17:34:59",
  "modifyUserId": 562,
  "modifyTime": "2023-09-27 17:34:59",
  "deleteFlag": 0,
  "ignoreWarning": true,
  "nullFields": [
    "7aj6yv"
  ],
  "changeLogId": 41,
  "shortUrlRelative": "ry2yym",
  "shortUrlPre": "n7vps0",
  "longUrlPre": "wohek1",
  "ext1": "2kcds1",
  "ext2": "u8z6oo",
  "ext3": "3l1mbm",
  "ext4": "78bb5g",
  "ext5": "2ldq2y"
}'

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

└─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

锁版本

-

└─shortUrlRelative

string

短链地址-相对地址

-

└─shortUrlPre

string

短链地址前缀

-

└─longUrlPre

string

长链地址后缀

-

└─secTenantId

int64

数据归属租户id

-

└─ext1

string

拓展1

-

└─ext2

string

拓展2

-

└─ext3

string

拓展3

-

└─ext4

string

拓展4

-

└─ext5

string

拓展5

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {
    "id": 901,
    "tenantId": 637,
    "remark": "klse9q",
    "createUserId": 391,
    "creator": "ngf8e7",
    "createTime": "2023-09-27 17:34:59",
    "modifyUserId": 934,
    "updater": "t6jx78",
    "modifyTime": "2023-09-27 17:34:59",
    "deleteFlag": 0,
    "auditDataVersion": 505,
    "shortUrlRelative": "1fk1jq",
    "shortUrlPre": "y5ways",
    "longUrlPre": "niedne",
    "secTenantId": 783,
    "ext1": "7775u8",
    "ext2": "8l0zj5",
    "ext3": "0q88ea",
    "ext4": "3pam6u",
    "ext5": "3j16k8"
  },
  "infos": [
    {
      "localeCode": "88129",
      "msg": "dwx1k1",
      "defaultMsg": "xdmbhp",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "ilp0x0",
      "defaultMsg": "vc1f8r",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "fvnohx",
      "defaultMsg": "9w92ji",
      "context": {
        "object": "any object"
      }
    }
  ]
}

53.3.短链服务配置-主键查询

Type: GET

Author: duwh

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

Description: 短链服务配置-主键查询

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Path-parameters:

ParameterTypeDescriptionRequiredSince

key

int64

关键

true

-

Request-example:

curl -X GET -H 'Authorization' -i /api/prd/shortUrlConf/162

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

└─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

锁版本

-

└─shortUrlRelative

string

短链地址-相对地址

-

└─shortUrlPre

string

短链地址前缀

-

└─longUrlPre

string

长链地址后缀

-

└─secTenantId

int64

数据归属租户id

-

└─ext1

string

拓展1

-

└─ext2

string

拓展2

-

└─ext3

string

拓展3

-

└─ext4

string

拓展4

-

└─ext5

string

拓展5

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {
    "id": 497,
    "tenantId": 37,
    "remark": "5cvvp3",
    "createUserId": 446,
    "creator": "umbu2i",
    "createTime": "2023-09-27 17:34:59",
    "modifyUserId": 831,
    "updater": "z8qq0y",
    "modifyTime": "2023-09-27 17:34:59",
    "deleteFlag": 0,
    "auditDataVersion": 939,
    "shortUrlRelative": "sdlq1o",
    "shortUrlPre": "3s25s8",
    "longUrlPre": "npm6e7",
    "secTenantId": 80,
    "ext1": "9tkmri",
    "ext2": "fcke8t",
    "ext3": "c56fle",
    "ext4": "8wgj91",
    "ext5": "71w0wy"
  },
  "infos": [
    {
      "localeCode": "88129",
      "msg": "fzxuwu",
      "defaultMsg": "y0nvpq",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "no5e7t",
      "defaultMsg": "jhd8oo",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "pz79h1",
      "defaultMsg": "qvuyqb",
      "context": {
        "object": "any object"
      }
    }
  ]
}

53.4.短链服务配置-分页

Type: GET

Author: duwh

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

Description: 短链服务配置-分页

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

current

int32

页码，默认为1

false

-

size

int32

页大小，默认为10

false

-

keyword

string

搜索关键字

false

-

idSet

object

ID

false

-

orders

array

排序

false

-

└─column

string

属性名称

false

-

└─asc

boolean

是否升序

false

-

remark

string

No comments found.

false

-

createUserId

int64

No comments found.

false

-

loginUserId

int64

登录用户id 用于数据权限

false

-

createTimeStart

string

No comments found.

false

-

createTimeEnd

string

No comments found.

false

-

modifyUserId

int64

No comments found.

false

-

modifyTimeStart

string

No comments found.

false

-

modifyTimeEnd

string

No comments found.

false

-

dataPermissionFlag

boolean

No comments found.

false

-

id

int64

记录唯一ID 精确

false

-

shortUrlRelative

string

短链地址-相对地址

false

-

shortUrlPre

string

短链地址前缀 精确

false

-

longUrlPre

string

长链地址后缀 精确

false

-

secTenantId

int64

数据归属租户id

false

-

ext1

string

拓展1 精确

false

-

ext2

string

拓展2 精确

false

-

ext3

string

拓展3 精确

false

-

ext4

string

拓展4 精确

false

-

ext5

string

拓展5 精确

false

-

Request-example:

curl -X GET -H 'Authorization' -i /api/prd/shortUrlConf/paging?current=421&size=10&keyword=9l2m1o&column=q6uf03&asc=true&remark=7vu9rf&createUserId=249&loginUserId=384&createTimeStart=2023-09-27 17:34:59&createTimeEnd=2023-09-27 17:34:59&modifyUserId=89&modifyTimeStart=2023-09-27 17:34:59&modifyTimeEnd=2023-09-27 17:34:59&dataPermissionFlag=true&id=259&shortUrlRelative=fr056n&shortUrlPre=ibwbaj&longUrlPre=xl2rc0&secTenantId=335&ext1=5l1216&ext2=l9i1y5&ext3=kcks5q&ext4=ckhm3v&ext5=0y23wv&orders[0].asc=true&orders[0].column=jvhfal

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

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

锁版本

-

     └─shortUrlRelative

string

短链地址-相对地址

-

     └─shortUrlPre

string

短链地址前缀

-

     └─longUrlPre

string

长链地址后缀

-

     └─secTenantId

int64

数据归属租户id

-

     └─ext1

string

拓展1

-

     └─ext2

string

拓展2

-

     └─ext3

string

拓展3

-

     └─ext4

string

拓展4

-

     └─ext5

string

拓展5

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {
    "total": 73,
    "records": [
      {
        "id": 425,
        "tenantId": 355,
        "remark": "78ykwc",
        "createUserId": 363,
        "creator": "njxt7x",
        "createTime": "2023-09-27 17:34:59",
        "modifyUserId": 491,
        "updater": "dtna17",
        "modifyTime": "2023-09-27 17:34:59",
        "deleteFlag": 0,
        "auditDataVersion": 643,
        "shortUrlRelative": "p4yatm",
        "shortUrlPre": "hmkfxh",
        "longUrlPre": "atd4x4",
        "secTenantId": 933,
        "ext1": "20d4py",
        "ext2": "wz7o3k",
        "ext3": "fgxwd5",
        "ext4": "4vvy8f",
        "ext5": "rqs426"
      }
    ]
  },
  "infos": [
    {
      "localeCode": "88129",
      "msg": "icqny0",
      "defaultMsg": "08guo7",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "86aswv",
      "defaultMsg": "bexipn",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "27cl7x",
      "defaultMsg": "i6qlyo",
      "context": {
        "object": "any object"
      }
    }
  ]
}

53.5.短链服务配置-查询列表

Type: GET

Author: duwh

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

Description: 短链服务配置-查询列表

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

current

int32

页码，默认为1

false

-

size

int32

页大小，默认为10

false

-

keyword

string

搜索关键字

false

-

idSet

object

ID

false

-

orders

array

排序

false

-

└─column

string

属性名称

false

-

└─asc

boolean

是否升序

false

-

remark

string

No comments found.

false

-

createUserId

int64

No comments found.

false

-

loginUserId

int64

登录用户id 用于数据权限

false

-

createTimeStart

string

No comments found.

false

-

createTimeEnd

string

No comments found.

false

-

modifyUserId

int64

No comments found.

false

-

modifyTimeStart

string

No comments found.

false

-

modifyTimeEnd

string

No comments found.

false

-

dataPermissionFlag

boolean

No comments found.

false

-

id

int64

记录唯一ID 精确

false

-

shortUrlRelative

string

短链地址-相对地址

false

-

shortUrlPre

string

短链地址前缀 精确

false

-

longUrlPre

string

长链地址后缀 精确

false

-

secTenantId

int64

数据归属租户id

false

-

ext1

string

拓展1 精确

false

-

ext2

string

拓展2 精确

false

-

ext3

string

拓展3 精确

false

-

ext4

string

拓展4 精确

false

-

ext5

string

拓展5 精确

false

-

Request-example:

curl -X GET -H 'Authorization' -i /api/prd/shortUrlConf/list?current=191&size=10&keyword=45y6y2&column=xk6kpd&asc=true&remark=calow2&createUserId=810&loginUserId=490&createTimeStart=2023-09-27 17:34:59&createTimeEnd=2023-09-27 17:34:59&modifyUserId=940&modifyTimeStart=2023-09-27 17:34:59&modifyTimeEnd=2023-09-27 17:34:59&dataPermissionFlag=true&id=127&shortUrlRelative=yg7tuo&shortUrlPre=rmidz6&longUrlPre=s3xvb6&secTenantId=145&ext1=93ckrn&ext2=cbdscy&ext3=x31my2&ext4=dijzyu&ext5=5iefzu&orders[0].asc=true&orders[0].column=7t6a3x

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

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

锁版本

-

└─shortUrlRelative

string

短链地址-相对地址

-

└─shortUrlPre

string

短链地址前缀

-

└─longUrlPre

string

长链地址后缀

-

└─secTenantId

int64

数据归属租户id

-

└─ext1

string

拓展1

-

└─ext2

string

拓展2

-

└─ext3

string

拓展3

-

└─ext4

string

拓展4

-

└─ext5

string

拓展5

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": [
    {
      "id": 110,
      "tenantId": 602,
      "remark": "78hn9d",
      "createUserId": 698,
      "creator": "i9unya",
      "createTime": "2023-09-27 17:34:59",
      "modifyUserId": 631,
      "updater": "qj2xjy",
      "modifyTime": "2023-09-27 17:34:59",
      "deleteFlag": 0,
      "auditDataVersion": 256,
      "shortUrlRelative": "a94mgv",
      "shortUrlPre": "yectyk",
      "longUrlPre": "vg6bir",
      "secTenantId": 818,
      "ext1": "5l6akn",
      "ext2": "wjnvmo",
      "ext3": "3j5eqe",
      "ext4": "lohg8h",
      "ext5": "xizncy"
    }
  ],
  "infos": [
    {
      "localeCode": "88129",
      "msg": "dr2u1b",
      "defaultMsg": "4dhm5o",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "13ucf7",
      "defaultMsg": "gge026",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "tliqkw",
      "defaultMsg": "qm28j6",
      "context": {
        "object": "any object"
      }
    }
  ]
}

53.6.短链服务配置-统计

Type: GET

Author: duwh

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

Description: 短链服务配置-统计

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

current

int32

页码，默认为1

false

-

size

int32

页大小，默认为10

false

-

keyword

string

搜索关键字

false

-

idSet

object

ID

false

-

orders

array

排序

false

-

└─column

string

属性名称

false

-

└─asc

boolean

是否升序

false

-

remark

string

No comments found.

false

-

createUserId

int64

No comments found.

false

-

loginUserId

int64

登录用户id 用于数据权限

false

-

createTimeStart

string

No comments found.

false

-

createTimeEnd

string

No comments found.

false

-

modifyUserId

int64

No comments found.

false

-

modifyTimeStart

string

No comments found.

false

-

modifyTimeEnd

string

No comments found.

false

-

dataPermissionFlag

boolean

No comments found.

false

-

id

int64

记录唯一ID 精确

false

-

shortUrlRelative

string

短链地址-相对地址

false

-

shortUrlPre

string

短链地址前缀 精确

false

-

longUrlPre

string

长链地址后缀 精确

false

-

secTenantId

int64

数据归属租户id

false

-

ext1

string

拓展1 精确

false

-

ext2

string

拓展2 精确

false

-

ext3

string

拓展3 精确

false

-

ext4

string

拓展4 精确

false

-

ext5

string

拓展5 精确

false

-

Request-example:

curl -X GET -H 'Authorization' -i /api/prd/shortUrlConf/count?current=582&size=10&keyword=npwb3p&column=zldo2d&asc=true&remark=nkucj5&createUserId=719&loginUserId=545&createTimeStart=2023-09-27 17:34:59&createTimeEnd=2023-09-27 17:34:59&modifyUserId=8&modifyTimeStart=2023-09-27 17:34:59&modifyTimeEnd=2023-09-27 17:34:59&dataPermissionFlag=true&id=444&shortUrlRelative=w44531&shortUrlPre=lg5ucm&longUrlPre=fv27yk&secTenantId=802&ext1=22s834&ext2=wjktxi&ext3=5pvmzg&ext4=wf2n9o&ext5=befg9t&orders[0].asc=true&orders[0].column=iwndij

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

int64

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": 670,
  "infos": [
    {
      "localeCode": "88129",
      "msg": "ak9hy0",
      "defaultMsg": "mgygk7",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "z20w5t",
      "defaultMsg": "5omei7",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "6g69xb",
      "defaultMsg": "07aaha",
      "context": {
        "object": "any object"
      }
    }
  ]
}

53.7.短链服务配置-删除

Type: DELETE

Author: duwh

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

Description: 短链服务配置-删除

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

keys

array

主键id,[array of int64]

false

-

Request-example:

curl -X DELETE -H 'Authorization' -i /api/prd/shortUrlConf/deleteSoft?keys=ni4vxy&keys=ni4vxy

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "ojqy49",
      "defaultMsg": "et7n9i",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "hnrryn",
      "defaultMsg": "8apsgr",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "pq3nl7",
      "defaultMsg": "zaqrrg",
      "context": {
        "object": "any object"
      }
    }
  ]
}

54.短链

54.1.短链-短链重定向

Type: GET

Author: duwh

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

Description: 短链-短链重定向

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Path-parameters:

ParameterTypeDescriptionRequiredSince

code

string

短链地址识别码

true

-

Request-example:

curl -X GET -H 'Authorization' -i /s/r/88129

Response-example:

Return void.

54.2.短链-短链转发

Type: GET

Author: duwh

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

Description: 短链-短链转发

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Path-parameters:

ParameterTypeDescriptionRequiredSince

code

string

短链地址识别码

true

-

Request-example:

curl -X GET -H 'Authorization' -i /s/f/88129

Response-example:

string

55.短链服务关系表

55.1.

Type: POST

Author: duwh

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

Description: 

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

longUrlSuffix

string

No comments found.

false

-

Request-example:

curl -X POST -H 'Authorization' -i /api/prd/shortUrlRef/saveRedirect --data 'longUrlSuffix=2tn3p7'

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

└─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

锁版本

-

└─shortUrl

string

短链地址

-

└─shortUrlRelative

string

短链地址-相对地址

-

└─code

string

短链地址识别码

-

└─longUrl

string

长链地址

-

└─visitNum

int32

访问数量

-

└─ext1

string

拓展1

-

└─ext2

string

拓展2

-

└─ext3

string

拓展3

-

└─ext4

string

拓展4

-

└─ext5

string

拓展5

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {
    "id": 284,
    "tenantId": 240,
    "remark": "s5qs3z",
    "createUserId": 159,
    "creator": "wl7zpo",
    "createTime": "2023-09-27 17:34:59",
    "modifyUserId": 970,
    "updater": "w7e6n7",
    "modifyTime": "2023-09-27 17:34:59",
    "deleteFlag": 0,
    "auditDataVersion": 226,
    "shortUrl": "www.lauretta-parisian.org",
    "shortUrlRelative": "zm5gvl",
    "code": "88129",
    "longUrl": "www.lauretta-parisian.org",
    "visitNum": 926,
    "ext1": "cml90z",
    "ext2": "5yw2x2",
    "ext3": "4s0hpf",
    "ext4": "wl4yw1",
    "ext5": "myab3q"
  },
  "infos": [
    {
      "localeCode": "88129",
      "msg": "u5kpcp",
      "defaultMsg": "xxy18q",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "e2gi4w",
      "defaultMsg": "lgbzx7",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "qeoo9p",
      "defaultMsg": "d4uv64",
      "context": {
        "object": "any object"
      }
    }
  ]
}

55.2.

Type: POST

Author: duwh

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

Description: 

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

longUrlSuffix

string

No comments found.

false

-

Request-example:

curl -X POST -H 'Authorization' -i /api/prd/shortUrlRef/saveForward --data 'longUrlSuffix=uuip58'

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

└─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

锁版本

-

└─shortUrl

string

短链地址

-

└─shortUrlRelative

string

短链地址-相对地址

-

└─code

string

短链地址识别码

-

└─longUrl

string

长链地址

-

└─visitNum

int32

访问数量

-

└─ext1

string

拓展1

-

└─ext2

string

拓展2

-

└─ext3

string

拓展3

-

└─ext4

string

拓展4

-

└─ext5

string

拓展5

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {
    "id": 282,
    "tenantId": 483,
    "remark": "iln5w5",
    "createUserId": 571,
    "creator": "a77ajp",
    "createTime": "2023-09-27 17:34:59",
    "modifyUserId": 843,
    "updater": "srw7hr",
    "modifyTime": "2023-09-27 17:34:59",
    "deleteFlag": 0,
    "auditDataVersion": 435,
    "shortUrl": "www.lauretta-parisian.org",
    "shortUrlRelative": "842tq6",
    "code": "88129",
    "longUrl": "www.lauretta-parisian.org",
    "visitNum": 32,
    "ext1": "uu2xxi",
    "ext2": "w69m2l",
    "ext3": "2a11d3",
    "ext4": "frsh9d",
    "ext5": "cgpbyu"
  },
  "infos": [
    {
      "localeCode": "88129",
      "msg": "2unokj",
      "defaultMsg": "pm4asm",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "0fidfj",
      "defaultMsg": "wtgwt7",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "9s8gdk",
      "defaultMsg": "d8bcd2",
      "context": {
        "object": "any object"
      }
    }
  ]
}

55.3.短链服务关系表-新增

Type: POST

Author: duwh

Content-Type: application/json

Description: 短链服务关系表-新增

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Body-parameters:

ParameterTypeDescriptionRequiredSince

id

int64

No comments found.

false

-

remark

string

No comments found.

false

-

createUserId

int64

No comments found.

false

-

creator

string

记录创建者

false

-

createTime

string

No comments found.

false

-

modifyUserId

int64

No comments found.

false

-

modifyTime

string

No comments found.

false

-

deleteFlag

int32

No comments found.

false

-

ignoreWarning

boolean

No comments found.

false

-

nullFields

array

No comments found.

false

-

changeLogId

int64

No comments found.

false

-

shortUrl

string

短链地址

false

-

shortUrlRelative

string

短链地址-相对地址

false

-

code

string

短链地址识别码

false

-

longUrl

string

长链地址

false

-

visitNum

int32

访问数量

false

-

ext1

string

拓展1

false

-

ext2

string

拓展2

false

-

ext3

string

拓展3

false

-

ext4

string

拓展4

false

-

ext5

string

拓展5

false

-

Request-example:

curl -X POST -H 'Content-Type: application/json' -H 'Authorization' -i /api/prd/shortUrlRef --data '{
  "id": 490,
  "remark": "af6nb4",
  "createUserId": 592,
  "creator": "hrwnbm",
  "createTime": "2023-09-27 17:34:59",
  "modifyUserId": 240,
  "modifyTime": "2023-09-27 17:34:59",
  "deleteFlag": 0,
  "ignoreWarning": true,
  "nullFields": [
    "lmv2oa"
  ],
  "changeLogId": 281,
  "shortUrl": "www.lauretta-parisian.org",
  "shortUrlRelative": "fd09e7",
  "code": "88129",
  "longUrl": "www.lauretta-parisian.org",
  "visitNum": 313,
  "ext1": "55rjcl",
  "ext2": "v60fhk",
  "ext3": "yxbbs6",
  "ext4": "51abn2",
  "ext5": "8qlpel"
}'

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

└─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

锁版本

-

└─shortUrl

string

短链地址

-

└─shortUrlRelative

string

短链地址-相对地址

-

└─code

string

短链地址识别码

-

└─longUrl

string

长链地址

-

└─visitNum

int32

访问数量

-

└─ext1

string

拓展1

-

└─ext2

string

拓展2

-

└─ext3

string

拓展3

-

└─ext4

string

拓展4

-

└─ext5

string

拓展5

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {
    "id": 620,
    "tenantId": 660,
    "remark": "gnre5g",
    "createUserId": 443,
    "creator": "s0y2h8",
    "createTime": "2023-09-27 17:34:59",
    "modifyUserId": 630,
    "updater": "ebi33q",
    "modifyTime": "2023-09-27 17:34:59",
    "deleteFlag": 0,
    "auditDataVersion": 699,
    "shortUrl": "www.lauretta-parisian.org",
    "shortUrlRelative": "4x8fy9",
    "code": "88129",
    "longUrl": "www.lauretta-parisian.org",
    "visitNum": 161,
    "ext1": "f1ch1k",
    "ext2": "9jv0ti",
    "ext3": "u5xxyu",
    "ext4": "yczls7",
    "ext5": "vdbn1w"
  },
  "infos": [
    {
      "localeCode": "88129",
      "msg": "451i8h",
      "defaultMsg": "s8j5jh",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "mcarq6",
      "defaultMsg": "e2lm0r",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "8rigwo",
      "defaultMsg": "x57vhm",
      "context": {
        "object": "any object"
      }
    }
  ]
}

55.4.短链服务关系表-更新

Type: PUT

Author: duwh

Content-Type: application/json

Description: 短链服务关系表-更新

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Body-parameters:

ParameterTypeDescriptionRequiredSince

id

int64

No comments found.

false

-

remark

string

No comments found.

false

-

createUserId

int64

No comments found.

false

-

creator

string

记录创建者

false

-

createTime

string

No comments found.

false

-

modifyUserId

int64

No comments found.

false

-

modifyTime

string

No comments found.

false

-

deleteFlag

int32

No comments found.

false

-

ignoreWarning

boolean

No comments found.

false

-

nullFields

array

No comments found.

false

-

changeLogId

int64

No comments found.

false

-

shortUrl

string

短链地址

false

-

shortUrlRelative

string

短链地址-相对地址

false

-

code

string

短链地址识别码

false

-

longUrl

string

长链地址

false

-

visitNum

int32

访问数量

false

-

ext1

string

拓展1

false

-

ext2

string

拓展2

false

-

ext3

string

拓展3

false

-

ext4

string

拓展4

false

-

ext5

string

拓展5

false

-

Request-example:

curl -X PUT -H 'Content-Type: application/json' -H 'Authorization' -i /api/prd/shortUrlRef --data '{
  "id": 450,
  "remark": "pxbrlr",
  "createUserId": 297,
  "creator": "j7u9ri",
  "createTime": "2023-09-27 17:34:59",
  "modifyUserId": 780,
  "modifyTime": "2023-09-27 17:34:59",
  "deleteFlag": 0,
  "ignoreWarning": true,
  "nullFields": [
    "d5z65u"
  ],
  "changeLogId": 426,
  "shortUrl": "www.lauretta-parisian.org",
  "shortUrlRelative": "1afl51",
  "code": "88129",
  "longUrl": "www.lauretta-parisian.org",
  "visitNum": 840,
  "ext1": "ha65kh",
  "ext2": "jluflw",
  "ext3": "713f51",
  "ext4": "7qsu3l",
  "ext5": "8qho2g"
}'

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

└─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

锁版本

-

└─shortUrl

string

短链地址

-

└─shortUrlRelative

string

短链地址-相对地址

-

└─code

string

短链地址识别码

-

└─longUrl

string

长链地址

-

└─visitNum

int32

访问数量

-

└─ext1

string

拓展1

-

└─ext2

string

拓展2

-

└─ext3

string

拓展3

-

└─ext4

string

拓展4

-

└─ext5

string

拓展5

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {
    "id": 730,
    "tenantId": 587,
    "remark": "t2vi8q",
    "createUserId": 134,
    "creator": "ft521c",
    "createTime": "2023-09-27 17:34:59",
    "modifyUserId": 91,
    "updater": "ft3b58",
    "modifyTime": "2023-09-27 17:34:59",
    "deleteFlag": 0,
    "auditDataVersion": 157,
    "shortUrl": "www.lauretta-parisian.org",
    "shortUrlRelative": "dfr4yx",
    "code": "88129",
    "longUrl": "www.lauretta-parisian.org",
    "visitNum": 550,
    "ext1": "1wmzaj",
    "ext2": "jgn7kp",
    "ext3": "kgp0b8",
    "ext4": "ow1j35",
    "ext5": "8em7mx"
  },
  "infos": [
    {
      "localeCode": "88129",
      "msg": "qmsjfk",
      "defaultMsg": "2w8c3a",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "ukplkb",
      "defaultMsg": "fsasvy",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "snznz1",
      "defaultMsg": "3p7s6q",
      "context": {
        "object": "any object"
      }
    }
  ]
}

55.5.短链服务关系表-主键查询

Type: GET

Author: duwh

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

Description: 短链服务关系表-主键查询

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Path-parameters:

ParameterTypeDescriptionRequiredSince

key

int64

关键

true

-

Request-example:

curl -X GET -H 'Authorization' -i /api/prd/shortUrlRef/256

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

└─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

锁版本

-

└─shortUrl

string

短链地址

-

└─shortUrlRelative

string

短链地址-相对地址

-

└─code

string

短链地址识别码

-

└─longUrl

string

长链地址

-

└─visitNum

int32

访问数量

-

└─ext1

string

拓展1

-

└─ext2

string

拓展2

-

└─ext3

string

拓展3

-

└─ext4

string

拓展4

-

└─ext5

string

拓展5

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {
    "id": 926,
    "tenantId": 160,
    "remark": "rl7bnt",
    "createUserId": 845,
    "creator": "c09qfm",
    "createTime": "2023-09-27 17:34:59",
    "modifyUserId": 268,
    "updater": "ezhlis",
    "modifyTime": "2023-09-27 17:34:59",
    "deleteFlag": 0,
    "auditDataVersion": 420,
    "shortUrl": "www.lauretta-parisian.org",
    "shortUrlRelative": "wt57hh",
    "code": "88129",
    "longUrl": "www.lauretta-parisian.org",
    "visitNum": 741,
    "ext1": "szfme5",
    "ext2": "8faxhh",
    "ext3": "t8ourk",
    "ext4": "ubbxos",
    "ext5": "zi2518"
  },
  "infos": [
    {
      "localeCode": "88129",
      "msg": "3mi8gy",
      "defaultMsg": "294oe9",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "hflsav",
      "defaultMsg": "2odh7d",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "0nvabu",
      "defaultMsg": "cykdnc",
      "context": {
        "object": "any object"
      }
    }
  ]
}

55.6.短链服务关系表-分页

Type: GET

Author: duwh

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

Description: 短链服务关系表-分页

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

current

int32

页码，默认为1

false

-

size

int32

页大小，默认为10

false

-

keyword

string

搜索关键字

false

-

idSet

object

ID

false

-

orders

array

排序

false

-

└─column

string

属性名称

false

-

└─asc

boolean

是否升序

false

-

remark

string

No comments found.

false

-

createUserId

int64

No comments found.

false

-

loginUserId

int64

登录用户id 用于数据权限

false

-

createTimeStart

string

No comments found.

false

-

createTimeEnd

string

No comments found.

false

-

modifyUserId

int64

No comments found.

false

-

modifyTimeStart

string

No comments found.

false

-

modifyTimeEnd

string

No comments found.

false

-

dataPermissionFlag

boolean

No comments found.

false

-

id

int64

记录唯一ID 精确

false

-

shortUrl

string

短链地址 精确

false

-

shortUrlRelative

string

短链地址-相对地址

false

-

code

string

短链地址识别码

false

-

longUrl

string

长链地址 精确

false

-

visitNum

int32

访问数量 精确

false

-

ext1

string

拓展1 精确

false

-

ext2

string

拓展2 精确

false

-

ext3

string

拓展3 精确

false

-

ext4

string

拓展4 精确

false

-

ext5

string

拓展5 精确

false

-

Request-example:

curl -X GET -H 'Authorization' -i /api/prd/shortUrlRef/paging?current=538&size=10&keyword=iopnft&column=9f73c1&asc=true&remark=ovhbuh&createUserId=181&loginUserId=934&createTimeStart=2023-09-27 17:34:59&createTimeEnd=2023-09-27 17:34:59&modifyUserId=944&modifyTimeStart=2023-09-27 17:34:59&modifyTimeEnd=2023-09-27 17:34:59&dataPermissionFlag=true&id=313&shortUrl=www.lauretta-parisian.org&shortUrlRelative=0252h3&code=88129&longUrl=www.lauretta-parisian.org&visitNum=712&ext1=2ofitt&ext2=g3znlj&ext3=b3lwge&ext4=6pic92&ext5=ktip2x&orders[0].column=pfrgce&orders[0].asc=true

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

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

锁版本

-

     └─shortUrl

string

短链地址

-

     └─shortUrlRelative

string

短链地址-相对地址

-

     └─code

string

短链地址识别码

-

     └─longUrl

string

长链地址

-

     └─visitNum

int32

访问数量

-

     └─ext1

string

拓展1

-

     └─ext2

string

拓展2

-

     └─ext3

string

拓展3

-

     └─ext4

string

拓展4

-

     └─ext5

string

拓展5

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {
    "total": 355,
    "records": [
      {
        "id": 489,
        "tenantId": 5,
        "remark": "92x28m",
        "createUserId": 302,
        "creator": "nhj9qx",
        "createTime": "2023-09-27 17:34:59",
        "modifyUserId": 410,
        "updater": "vjtamw",
        "modifyTime": "2023-09-27 17:34:59",
        "deleteFlag": 0,
        "auditDataVersion": 956,
        "shortUrl": "www.lauretta-parisian.org",
        "shortUrlRelative": "mogxv8",
        "code": "88129",
        "longUrl": "www.lauretta-parisian.org",
        "visitNum": 858,
        "ext1": "fckd51",
        "ext2": "9vua5x",
        "ext3": "2lz5ws",
        "ext4": "314w1k",
        "ext5": "xy5cmr"
      }
    ]
  },
  "infos": [
    {
      "localeCode": "88129",
      "msg": "a58705",
      "defaultMsg": "cqk20g",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "6sfnml",
      "defaultMsg": "bg8a4e",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "vd6etg",
      "defaultMsg": "w4jhyo",
      "context": {
        "object": "any object"
      }
    }
  ]
}

55.7.短链服务关系表-删除

Type: DELETE

Author: duwh

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

Description: 短链服务关系表-删除

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

keys

array

主键id,[array of int64]

false

-

Request-example:

curl -X DELETE -H 'Authorization' -i /api/prd/shortUrlRef/deleteSoft?keys=evr3w6&keys=evr3w6

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "mip94a",
      "defaultMsg": "ghkb3v",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "fqw8nt",
      "defaultMsg": "5vv0n5",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "nt4v8p",
      "defaultMsg": "u7370a",
      "context": {
        "object": "any object"
      }
    }
  ]
}

56.短链服务请求记录

56.1.短链服务请求记录-主键查询

Type: GET

Author: duwh

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

Description: 短链服务请求记录-主键查询

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Path-parameters:

ParameterTypeDescriptionRequiredSince

key

int64

关键

true

-

Request-example:

curl -X GET -H 'Authorization' -i /api/prd/shortUrlRequestLog/793

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

└─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

锁版本

-

└─shortId

int64

prd_short_url.id

-

└─shortUrl

string

短链地址

-

└─longUrl

string

长链地址

-

└─params

string

参数

-

└─requestIp

string

ip来源

-

└─time

int64

耗时

-

└─address

string

请求所属地址

-

└─browser

string

浏览器

-

└─ext1

string

拓展1

-

└─ext2

string

拓展2

-

└─ext3

string

拓展3

-

└─ext4

string

拓展4

-

└─ext5

string

拓展5

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {
    "id": 394,
    "tenantId": 818,
    "remark": "028iua",
    "createUserId": 762,
    "creator": "ao2e01",
    "createTime": "2023-09-27 17:34:59",
    "modifyUserId": 905,
    "updater": "v3ovn1",
    "modifyTime": "2023-09-27 17:34:59",
    "deleteFlag": 0,
    "auditDataVersion": 881,
    "shortId": 868,
    "shortUrl": "www.lauretta-parisian.org",
    "longUrl": "www.lauretta-parisian.org",
    "params": "fu2klh",
    "requestIp": "233.15.56.44",
    "time": 1695807296827,
    "address": "Apt. 994 784 Tom Junction， West Francine， MS 22939",
    "browser": "cxn7jj",
    "ext1": "ij6t9l",
    "ext2": "wx78zs",
    "ext3": "2inze3",
    "ext4": "am6px5",
    "ext5": "m613yt"
  },
  "infos": [
    {
      "localeCode": "88129",
      "msg": "jezn1e",
      "defaultMsg": "oyfqp4",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "nwjy16",
      "defaultMsg": "rtyp22",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "13lx82",
      "defaultMsg": "3k9n4l",
      "context": {
        "object": "any object"
      }
    }
  ]
}

56.2.短链服务请求记录-分页

Type: GET

Author: duwh

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

Description: 短链服务请求记录-分页

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

current

int32

页码，默认为1

false

-

size

int32

页大小，默认为10

false

-

keyword

string

搜索关键字

false

-

idSet

object

ID

false

-

orders

array

排序

false

-

└─column

string

属性名称

false

-

└─asc

boolean

是否升序

false

-

remark

string

No comments found.

false

-

createUserId

int64

No comments found.

false

-

loginUserId

int64

登录用户id 用于数据权限

false

-

createTimeStart

string

No comments found.

false

-

createTimeEnd

string

No comments found.

false

-

modifyUserId

int64

No comments found.

false

-

modifyTimeStart

string

No comments found.

false

-

modifyTimeEnd

string

No comments found.

false

-

dataPermissionFlag

boolean

No comments found.

false

-

id

int64

记录唯一ID 精确

false

-

shortId

int64

prd_short_url.id 精确

false

-

shortUrl

string

短链地址 精确

false

-

longUrl

string

长链地址 精确

false

-

params

string

参数 精确

false

-

requestIp

string

ip来源 精确

false

-

time

int64

耗时 精确

false

-

address

string

请求所属地址 精确

false

-

browser

string

浏览器 精确

false

-

ext1

string

拓展1 精确

false

-

ext2

string

拓展2 精确

false

-

ext3

string

拓展3 精确

false

-

ext4

string

拓展4 精确

false

-

ext5

string

拓展5 精确

false

-

Request-example:

curl -X GET -H 'Authorization' -i /api/prd/shortUrlRequestLog/paging?current=204&size=10&keyword=n4ijiu&column=3vs90a&asc=true&remark=qlx5z8&createUserId=633&loginUserId=950&createTimeStart=2023-09-27 17:34:59&createTimeEnd=2023-09-27 17:34:59&modifyUserId=733&modifyTimeStart=2023-09-27 17:34:59&modifyTimeEnd=2023-09-27 17:34:59&dataPermissionFlag=true&id=585&shortId=221&shortUrl=www.lauretta-parisian.org&longUrl=www.lauretta-parisian.org¶ms=e2q2ds&requestIp=233.15.56.44&time=1695807296827&address=Apt. 994 784 Tom Junction， West Francine， MS 22939&browser=xyoy3e&ext1=m4vp1u&ext2=n60ujy&ext3=tc59r4&ext4=mv42yo&ext5=7c86at&orders[0].asc=true&orders[0].column=fvhzqx

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

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

锁版本

-

     └─shortId

int64

prd_short_url.id

-

     └─shortUrl

string

短链地址

-

     └─longUrl

string

长链地址

-

     └─params

string

参数

-

     └─requestIp

string

ip来源

-

     └─time

int64

耗时

-

     └─address

string

请求所属地址

-

     └─browser

string

浏览器

-

     └─ext1

string

拓展1

-

     └─ext2

string

拓展2

-

     └─ext3

string

拓展3

-

     └─ext4

string

拓展4

-

     └─ext5

string

拓展5

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {
    "total": 824,
    "records": [
      {
        "id": 388,
        "tenantId": 501,
        "remark": "5p8d0k",
        "createUserId": 453,
        "creator": "e23qz9",
        "createTime": "2023-09-27 17:34:59",
        "modifyUserId": 965,
        "updater": "ckfg2z",
        "modifyTime": "2023-09-27 17:34:59",
        "deleteFlag": 0,
        "auditDataVersion": 564,
        "shortId": 70,
        "shortUrl": "www.lauretta-parisian.org",
        "longUrl": "www.lauretta-parisian.org",
        "params": "wolvyi",
        "requestIp": "233.15.56.44",
        "time": 1695807296827,
        "address": "Apt. 994 784 Tom Junction， West Francine， MS 22939",
        "browser": "qsrom0",
        "ext1": "n3hd9h",
        "ext2": "eantby",
        "ext3": "qvv2j9",
        "ext4": "l9gapj",
        "ext5": "hylmb5"
      }
    ]
  },
  "infos": [
    {
      "localeCode": "88129",
      "msg": "ete736",
      "defaultMsg": "3tmwl5",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "2emmsc",
      "defaultMsg": "eju4nb",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "bo8co6",
      "defaultMsg": "3p10z1",
      "context": {
        "object": "any object"
      }
    }
  ]
}

56.3.短链服务请求记录-删除

Type: DELETE

Author: duwh

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

Description: 短链服务请求记录-删除

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

keys

array

主键id,[array of int64]

false

-

Request-example:

curl -X DELETE -H 'Authorization' -i /api/prd/shortUrlRequestLog/deleteSoft?keys=7tnd7y&keys=7tnd7y

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "f6shs6",
      "defaultMsg": "1i6uvg",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "ezdlqx",
      "defaultMsg": "6hwhxx",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "zvhni5",
      "defaultMsg": "7qlnyr",
      "context": {
        "object": "any object"
      }
    }
  ]
}

57.第三方api请求日志控制器

57.1.主键查询

Type: GET

Author: duwh

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

Description: 主键查询

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Path-parameters:

ParameterTypeDescriptionRequiredSince

key

int64

关键

true

-

Request-example:

curl -X GET -H 'Authorization' -i /api/request/log/717

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "rhkut7",
      "defaultMsg": "fg340p",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "f2e7px",
      "defaultMsg": "3f6mwz",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "z8zhf6",
      "defaultMsg": "b0ddv4",
      "context": {
        "object": "any object"
      }
    }
  ]
}

57.2.分页

Type: GET

Author: duwh

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

Description: 分页

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

current

int32

页码，默认为1

false

-

size

int32

页大小，默认为10

false

-

keyword

string

搜索关键字

false

-

idSet

object

ID

false

-

orders

array

排序

false

-

└─column

string

属性名称

false

-

└─asc

boolean

是否升序

false

-

id

int64

No comments found.

false

-

createUserId

int64

No comments found.

false

-

loginUserId

int64

登录用户id 用于数据权限

false

-

modifyUserId

int64

No comments found.

false

-

modifyTimeStart

string

No comments found.

false

-

modifyTimeEnd

string

No comments found.

false

-

dataPermissionFlag

boolean

No comments found.

false

-

type

enum

类型 新增接口，需要维护
[Enum values:
YEEDOC("YEEDOC", "易稻壳")
TYC("TYC", "天眼查")
QXB("QXB", "启信宝")
]

false

-

channel

enum

调入or调出
[Enum values:
IN("IN", "外部系统调入")
OUT("OUT", "调外部系统")
]

false

-

uri

string

uri

false

-

creator

string

创建者

false

-

requestMethod

object

No comments found.

false

-

param

string

参数

false

-

header

string

头

false

-

result

string

结果

false

-

status

string

状态

false

-

time

int64

时间

false

-

remark

string

备注

false

-

ext1

string

ext1

false

-

ext2

string

ext2

false

-

ext3

string

ext3

false

-

ext4

string

ext4

false

-

createTimeStart

string

创建时间起

false

-

createTimeEnd

string

创建时间止

false

-

Request-example:

curl -X GET -H 'Authorization' -i /api/request/log/paging?current=894&size=10&keyword=2rv87g&column=ph2njz&asc=true&id=554&createUserId=704&loginUserId=28&modifyUserId=83&modifyTimeStart=2023-09-27 17:34:59&modifyTimeEnd=2023-09-27 17:34:59&dataPermissionFlag=true&type=YEEDOC&channel=IN&uri=5jlzsh&creator=o9hufz¶m=pmxt74&header=jk1gho&result=x7yefe&status=zditz4&time=1695807296827&remark=8byjy2&ext1=gj3kl5&ext2=g5gfi1&ext3=tytqkw&ext4=z7odhp&createTimeStart=2023-09-27 17:34:59&createTimeEnd=2023-09-27 17:34:59&orders[0].asc=true&orders[0].column=otqh5r

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "820bp2",
      "defaultMsg": "jhl48h",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "0n2pi5",
      "defaultMsg": "bl57ge",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "x52upi",
      "defaultMsg": "q6ogap",
      "context": {
        "object": "any object"
      }
    }
  ]
}

57.3.日志类型列表

Type: GET

Author: duwh

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

Description: 日志类型列表

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Request-example:

curl -X GET -H 'Authorization' -i /api/request/log/logTypeList

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "npll5a",
      "defaultMsg": "kolcaz",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "mn1zvt",
      "defaultMsg": "6tyg2i",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "xv54gj",
      "defaultMsg": "j5jr4b",
      "context": {
        "object": "any object"
      }
    }
  ]
}

57.4.删除

Type: DELETE

Author: duwh

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

Description: 删除

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

keys

array

主键id,[array of int64]

false

-

Request-example:

curl -X DELETE -H 'Authorization' -i /api/request/log/deleteSoft?keys=hollte&keys=hollte

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "9z6loz",
      "defaultMsg": "cj5yc6",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "nkhm8a",
      "defaultMsg": "l57nxb",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "amtlq6",
      "defaultMsg": "zlvrmh",
      "context": {
        "object": "any object"
      }
    }
  ]
}

57.5.物理删除

Type: DELETE

Author: duwh

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

Description: 物理删除

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

keys

array

主键id,[array of int64]

false

-

Request-example:

curl -X DELETE -H 'Authorization' -i /api/request/log/delete?keys=wdo7n8&keys=wdo7n8

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "p4nvc1",
      "defaultMsg": "99ux4b",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "93pbhc",
      "defaultMsg": "f30y4n",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "qry1zw",
      "defaultMsg": "18p8lw",
      "context": {
        "object": "any object"
      }
    }
  ]
}

58.日志记录

58.1.主键查询

Type: GET

Author: duwh

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

Description: 主键查询

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Path-parameters:

ParameterTypeDescriptionRequiredSince

key

int64

关键

true

-

Request-example:

curl -X GET -H 'Authorization' -i /api/common/log/507

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "a52xlv",
      "defaultMsg": "ashpy0",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "p0zxx4",
      "defaultMsg": "szwmhp",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "otlwxx",
      "defaultMsg": "g5vuo3",
      "context": {
        "object": "any object"
      }
    }
  ]
}

58.2.分页

Type: GET

Author: duwh

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

Description: 分页

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

current

int32

页码，默认为1

false

-

size

int32

页大小，默认为10

false

-

keyword

string

搜索关键字

false

-

idSet

object

ID

false

-

orders

array

排序

false

-

└─column

string

属性名称

false

-

└─asc

boolean

是否升序

false

-

id

int64

No comments found.

false

-

remark

string

No comments found.

false

-

createUserId

int64

No comments found.

false

-

loginUserId

int64

登录用户id 用于数据权限

false

-

modifyUserId

int64

No comments found.

false

-

modifyTimeStart

string

No comments found.

false

-

modifyTimeEnd

string

No comments found.

false

-

dataPermissionFlag

boolean

No comments found.

false

-

logType

string

日志类型 ERROR INFO 精确

false

-

method

string

方法路径 模糊

false

-

params

string

参数 模糊

false

-

requestIp

string

ip来源 模糊

false

-

address

string

请求所属地址 模糊

false

-

browser

string

浏览器 模糊

false

-

exceptionDetail

string

异常详情 模糊

false

-

time

array

耗时 BETWEEN

false

-

creator

string

创建者

false

-

createTimeStart

string

创建时间起

false

-

createTimeEnd

string

创建时间止

false

-

Request-example:

curl -X GET -H 'Authorization' -i /api/common/log/paging?current=893&size=10&keyword=n22xiw&column=m0fg6h&asc=true&id=806&remark=ry0csc&createUserId=979&loginUserId=639&modifyUserId=512&modifyTimeStart=2023-09-27 17:34:59&modifyTimeEnd=2023-09-27 17:34:59&dataPermissionFlag=true&logType=h3iuni&method=x43urt¶ms=suq4xk&requestIp=233.15.56.44&address=Apt. 994 784 Tom Junction， West Francine， MS 22939&browser=p8695d&exceptionDetail=lxcktg&time=1695807296827,1695807296827&creator=smocql&createTimeStart=2023-09-27 17:34:59&createTimeEnd=2023-09-27 17:34:59&orders[0].asc=true&orders[0].column=itpnhe

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "73fuqt",
      "defaultMsg": "0b2011",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "a8datx",
      "defaultMsg": "jtl87u",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "g2p1h4",
      "defaultMsg": "27uc9s",
      "context": {
        "object": "any object"
      }
    }
  ]
}

58.3.查询列表

Type: GET

Author: duwh

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

Description: 查询列表

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

current

int32

页码，默认为1

false

-

size

int32

页大小，默认为10

false

-

keyword

string

搜索关键字

false

-

idSet

object

ID

false

-

orders

array

排序

false

-

└─column

string

属性名称

false

-

└─asc

boolean

是否升序

false

-

id

int64

No comments found.

false

-

remark

string

No comments found.

false

-

createUserId

int64

No comments found.

false

-

loginUserId

int64

登录用户id 用于数据权限

false

-

modifyUserId

int64

No comments found.

false

-

modifyTimeStart

string

No comments found.

false

-

modifyTimeEnd

string

No comments found.

false

-

dataPermissionFlag

boolean

No comments found.

false

-

logType

string

日志类型 ERROR INFO 精确

false

-

method

string

方法路径 模糊

false

-

params

string

参数 模糊

false

-

requestIp

string

ip来源 模糊

false

-

address

string

请求所属地址 模糊

false

-

browser

string

浏览器 模糊

false

-

exceptionDetail

string

异常详情 模糊

false

-

time

array

耗时 BETWEEN

false

-

creator

string

创建者

false

-

createTimeStart

string

创建时间起

false

-

createTimeEnd

string

创建时间止

false

-

Request-example:

curl -X GET -H 'Authorization' -i /api/common/log/list?current=827&size=10&keyword=7rmxov&column=dz12b6&asc=true&id=582&remark=fr788g&createUserId=357&loginUserId=985&modifyUserId=228&modifyTimeStart=2023-09-27 17:34:59&modifyTimeEnd=2023-09-27 17:34:59&dataPermissionFlag=true&logType=t393ed&method=owyolx¶ms=dgmtex&requestIp=233.15.56.44&address=Apt. 994 784 Tom Junction， West Francine， MS 22939&browser=796v9l&exceptionDetail=krvzas&time=1695807296827,1695807296827&creator=4vclrb&createTimeStart=2023-09-27 17:34:59&createTimeEnd=2023-09-27 17:34:59&orders[0].asc=true&orders[0].column=f94f90

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "grzujn",
      "defaultMsg": "eagk84",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "vnogo8",
      "defaultMsg": "v15aev",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "aw4ghz",
      "defaultMsg": "16241b",
      "context": {
        "object": "any object"
      }
    }
  ]
}

58.4.删除

Type: DELETE

Author: duwh

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

Description: 删除

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

keys

array

主键id,[array of int64]

false

-

Request-example:

curl -X DELETE -H 'Authorization' -i /api/common/log/deleteSoft?keys=1au2mc&keys=1au2mc

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "jkojzv",
      "defaultMsg": "k61dm7",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "r9fgor",
      "defaultMsg": "gkke2t",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "1yc97x",
      "defaultMsg": "ch5nny",
      "context": {
        "object": "any object"
      }
    }
  ]
}

58.5.物理删除

Type: DELETE

Author: duwh

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

Description: 物理删除

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

keys

array

主键id,[array of int64]

false

-

Request-example:

curl -X DELETE -H 'Authorization' -i /api/common/log/log/delete?keys=jfkeqx&keys=jfkeqx

Response-fields:

FieldTypeDescriptionSince

ok

boolean

是否成功

-

data

object

业务数据

-

infos

array

成功信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

errors

array

错误信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

warns

array

警告信息

-

└─localeCode

string

国际化码

-

└─msg

string

返回信息

-

└─defaultMsg

string

默认信息

-

└─context

object

消息上下文,用于带变量类型的提示

-

Response-example:

{
  "ok": true,
  "data": {},
  "infos": [
    {
      "localeCode": "88129",
      "msg": "im5d8p",
      "defaultMsg": "odgrst",
      "context": {
        "object": "any object"
      }
    }
  ],
  "errors": [
    {
      "localeCode": "88129",
      "msg": "mawi3n",
      "defaultMsg": "wo25r9",
      "context": {
        "object": "any object"
      }
    }
  ],
  "warns": [
    {
      "localeCode": "88129",
      "msg": "c1fjod",
      "defaultMsg": "cmk35r",
      "context": {
        "object": "any object"
      }
    }
  ]
}

59.数据导入导出

59.1.下载模板文件

Type: GET

Author: Kaiser（wang shao）

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

Description: 下载模板文件

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Path-parameters:

ParameterTypeDescriptionRequiredSince

tmplCode

string

模板编号

true

-

Request-example:

curl -X GET -H 'Authorization' -i /com/import/88129/tmpl

Response-example:

File download.

59.2.根据模板导入数据

Type: POST

Author: Kaiser（wang shao）

Content-Type: multipart/form-data

Description: 根据模板导入数据

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Path-parameters:

ParameterTypeDescriptionRequiredSince

tmplCode

string

模板编号

true

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

file

file

数据文件

false

-

Request-example:

curl -X POST -H 'Content-Type: multipart/form-data' -H 'Authorization' -F 'file=' -i /com/import/88129/data

Response-fields:

FieldTypeDescriptionSince

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": 326,
  "msg": "h22c58",
  "success": true,
  "data": {
    "sync": true,
    "syncResult": {
      "total": 63,
      "numSuccess": 792,
      "failRecords": [
        "jrj8b8"
      ]
    },
    "asyncResult": {
      "importId": 488
    }
  },
  "time": "2023-09-27 17:34:59"
}

59.3.根据模板导出数据

Type: POST

Author: Kaiser（wang shao）

Content-Type: application/json

Description: 根据模板导出数据

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Path-parameters:

ParameterTypeDescriptionRequiredSince

tmplCode

string

模板编号

true

-

Body-parameters:

ParameterTypeDescriptionRequiredSince

any object

object

any object.

false

-

Request-example:

curl -X POST -H 'Content-Type: application/json' -H 'Authorization' -i /com/import/88129/export --data '{}'

Response-fields:

FieldTypeDescriptionSince

code

int32

响应码

-

msg

string

响应消息

-

success

boolean

是否成功

-

data

object

响应数据

-

└─sync

boolean

是否是同步导出

-

└─recordId

int64

导出记录的唯一标识

-

└─total

int64

总记录数

-

time

string

响应时间

-

Response-example:

{
  "code": 123,
  "msg": "7xgws7",
  "success": true,
  "data": {
    "sync": true,
    "recordId": 344,
    "total": 36
  },
  "time": "2023-09-27 17:34:59"
}

59.4.下载导出的数据文件

Type: GET

Author: Kaiser（wang shao）

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

Description: 下载导出的数据文件

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Path-parameters:

ParameterTypeDescriptionRequiredSince

recordId

int64

导出记录ID

true

-

Request-example:

curl -X GET -H 'Authorization' -i /com/import/export/418/file

Response-example:

File download.

59.5.查询导入（或导出）进度

Type: GET

Author: Kaiser（wang shao）

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

Description: 查询导入（或导出）进度

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Path-parameters:

ParameterTypeDescriptionRequiredSince

recordId

int64

导入(导出)记录ID

true

-

Request-example:

curl -X GET -H 'Authorization' -i /com/import/402/rate

Response-fields:

FieldTypeDescriptionSince

code

int32

响应码

-

msg

string

响应消息

-

success

boolean

是否成功

-

data

object

响应数据

-

└─finish

boolean

是否导入完毕

-

└─total

int32

记录总数

-

└─count

int32

已导入数量

-

└─rate

string

导入进度（百分比形式）

-

time

string

响应时间

-

Response-example:

{
  "code": 208,
  "msg": "cjcc6h",
  "success": true,
  "data": {
    "finish": true,
    "total": 653,
    "count": 386,
    "rate": "a8sx7z"
  },
  "time": "2023-09-27 17:34:59"
}

60.文件管理

60.1.上传单文件

Type: POST

Author: Kaiser（wang shao）

Content-Type: multipart/form-data

Description: 上传单文件

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

file

file

文件

false

-

Request-example:

curl -X POST -H 'Content-Type: multipart/form-data' -H 'Authorization' -F 'file=' -i /com/file/v1/upload

Response-fields:

FieldTypeDescriptionSince

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-视频），为空则表示不常见
[Enum values:
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": 523,
  "msg": "vn4rrs",
  "success": true,
  "data": {
    "fileCode": "88129",
    "originalName": "gil.paucek",
    "fileSize": 870,
    "suffix": "3tw7qb",
    "mimeType": "zgszvv",
    "fileType": "IMAGE",
    "uploadTime": "2023-09-27 17:34:59",
    "filePath": "2g0zar",
    "width": 454,
    "height": 126,
    "urlPreview": "2a0rml",
    "urlDownload": "uxwa9o",
    "urlDelete": "56a5bq",
    "url": "www.lauretta-parisian.org",
    "extraInfo": {}
  },
  "time": "2023-09-27 17:34:59"
}

60.2.请求分片上传

Type: POST

Author: Kaiser（wang shao）

Content-Type: application/json

Description: 请求分片上传

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Body-parameters:

ParameterTypeDescriptionRequiredSince

filename

string

文件名称

true

-

mimeType

string

文件类型，mime-type

false

-

size

int64

文件大小

true

-

Request-example:

curl -X POST -H 'Content-Type: application/json' -H 'Authorization' -i /com/file/v1/apply/chunk --data '{
  "filename": "gil.paucek",
  "mimeType": "87m8y0",
  "size": 247
}'

Response-fields:

FieldTypeDescriptionSince

code

int32

响应码

-

msg

string

响应消息

-

success

boolean

是否成功

-

data

int64

响应数据

-

time

string

响应时间

-

Response-example:

{
  "code": 553,
  "msg": "airmjk",
  "success": true,
  "data": 310,
  "time": "2023-09-27 17:34:59"
}

60.3.分片上传

Type: POST

Author: Kaiser（wang shao）

Content-Type: multipart/form-data

Description: 分片上传

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

file

file

文件

false

-

uploadId

int64

上传记录标识

true

-

merge

boolean

是否是合并

true

-

partNumber

int32

分片号，从0开始计数

false

-

Request-example:

curl -X POST -H 'Content-Type: multipart/form-data' -H 'Authorization' -F 'file=' -i /com/file/v1/upload/chunk --data 'uploadId=472&merge=true&partNumber=608'

Response-fields:

FieldTypeDescriptionSince

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-视频），为空则表示不常见
[Enum values:
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": 978,
  "msg": "53wr5y",
  "success": true,
  "data": {
    "fileCode": "88129",
    "originalName": "gil.paucek",
    "fileSize": 724,
    "suffix": "zpw9zk",
    "mimeType": "741gim",
    "fileType": "IMAGE",
    "uploadTime": "2023-09-27 17:34:59",
    "filePath": "9p6ggg",
    "width": 0,
    "height": 808,
    "urlPreview": "qvs5l3",
    "urlDownload": "sbks0z",
    "urlDelete": "8kwcnb",
    "url": "www.lauretta-parisian.org",
    "extraInfo": {}
  },
  "time": "2023-09-27 17:34:59"
}

60.4.查询单个文件信息

Type: GET

Author: Kaiser（wang shao）

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

Description: 查询单个文件信息

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Path-parameters:

ParameterTypeDescriptionRequiredSince

fileCode

string

文件编码

true

-

Request-example:

curl -X GET -H 'Authorization' -i /com/file/v1/88129

Response-fields:

FieldTypeDescriptionSince

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-视频），为空则表示不常见
[Enum values:
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": 411,
  "msg": "n4cdaj",
  "success": true,
  "data": {
    "fileCode": "88129",
    "originalName": "gil.paucek",
    "fileSize": 823,
    "suffix": "pmy06j",
    "mimeType": "25avy2",
    "fileType": "IMAGE",
    "uploadTime": "2023-09-27 17:34:59",
    "filePath": "lb2rg7",
    "width": 124,
    "height": 369,
    "urlPreview": "lyw4lk",
    "urlDownload": "zlrolj",
    "urlDelete": "fp0hvs",
    "url": "www.lauretta-parisian.org",
    "extraInfo": {}
  },
  "time": "2023-09-27 17:34:59"
}

60.5.查询单个文件信息

Type: POST

Author: Kaiser（wang shao）

Content-Type: application/json

Description: 查询单个文件信息

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Body-parameters:

ParameterTypeDescriptionRequiredSince

fileCodes

array

文件编码,[array of string]

false

-

Request-example:

curl -X POST -H 'Content-Type: application/json' -H 'Authorization' -i /com/file/v1/query --data '[
  "c7mcd2"
]'

Response-fields:

FieldTypeDescriptionSince

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-视频），为空则表示不常见
[Enum values:
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": 942,
  "msg": "q7tqu3",
  "success": true,
  "data": [
    {
      "fileCode": "88129",
      "originalName": "gil.paucek",
      "fileSize": 941,
      "suffix": "1xvqe1",
      "mimeType": "x6nul4",
      "fileType": "IMAGE",
      "uploadTime": "2023-09-27 17:34:59",
      "filePath": "gfd08i",
      "width": 11,
      "height": 43,
      "urlPreview": "4472em",
      "urlDownload": "c6qc1h",
      "urlDelete": "us57lc",
      "url": "www.lauretta-parisian.org",
      "extraInfo": {}
    }
  ],
  "time": "2023-09-27 17:34:59"
}

60.6.显示图片

Type: GET

Author: Kaiser（wang shao）

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

Description: 显示图片

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Path-parameters:

ParameterTypeDescriptionRequiredSince

fileCode

string

文件编码

true

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

thumbnail

boolean

是否是预览缩略图

false

-

Request-example:

curl -X GET -H 'Authorization' -i /com/file/v1/88129/show?thumbnail=true

Response-example:

File download.

60.7.下载文件

Type: GET

Author: Kaiser（wang shao）

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

Description: 下载文件

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Path-parameters:

ParameterTypeDescriptionRequiredSince

fileCode

string

文件编码

true

-

Request-example:

curl -X GET -H 'Authorization' -i /com/file/v1/88129/download

Response-example:

File download.

60.8.

Type: POST

Author: Kaiser（wang shao）

Content-Type: application/json

Description: 

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Body-parameters:

ParameterTypeDescriptionRequiredSince

packageName

string

No comments found.

false

-

fileList

array

打包文件

true

-

└─fileCode

string

文件编码

true

-

└─fileDirectories

array

文件目录列表

false

-

└─newFileName

string

文件名称

为空则使用原有名称

false

-

Request-example:

curl -X POST -H 'Content-Type: application/json' -H 'Authorization' -i /com/file/v1/download/package --data '{
  "packageName": "gil.paucek",
  "fileList": [
    {
      "fileCode": "88129",
      "fileDirectories": [
        "khrtsa"
      ],
      "newFileName": "gil.paucek"
    }
  ]
}'

Response-example:

{}

60.9.

Type: POST

Author: Kaiser（wang shao）

Content-Type: application/json

Description: 

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Body-parameters:

ParameterTypeDescriptionRequiredSince

packageName

string

No comments found.

false

-

fileList

array

打包文件

true

-

└─fileCode

string

文件编码

true

-

└─fileDirectories

array

文件目录列表

false

-

└─newFileName

string

文件名称

为空则使用原有名称

false

-

Request-example:

curl -X POST -H 'Content-Type: application/json' -H 'Authorization' -i /com/file/v1/package/apply --data '{
  "packageName": "gil.paucek",
  "fileList": [
    {
      "fileCode": "88129",
      "fileDirectories": [
        "34gjgn"
      ],
      "newFileName": "gil.paucek"
    }
  ]
}'

Response-fields:

FieldTypeDescriptionSince

code

int32

响应码

-

msg

string

响应消息

-

success

boolean

是否成功

-

data

int64

响应数据

-

time

string

响应时间

-

Response-example:

{
  "code": 518,
  "msg": "agubhe",
  "success": true,
  "data": 123,
  "time": "2023-09-27 17:34:59"
}

60.10.

Type: GET

Author: Kaiser（wang shao）

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

Description: 

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

applyId

int64

No comments found.

true

-

Request-example:

curl -X GET -H 'Authorization' -i /com/file/v1/package/result?applyId=245 --data '&245'

Response-fields:

FieldTypeDescriptionSince

code

int32

响应码

-

msg

string

响应消息

-

success

boolean

是否成功

-

data

object

响应数据

-

└─finished

boolean

是否结束

-

└─success

boolean

打包成功

-

└─msg

string

失败信息

-

time

string

响应时间

-

Response-example:

{
  "code": 714,
  "msg": "0p5lh2",
  "success": true,
  "data": {
    "finished": true,
    "success": true,
    "msg": "fojb0b"
  },
  "time": "2023-09-27 17:34:59"
}

60.11.

Type: GET

Author: Kaiser（wang shao）

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

Description: 

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Query-parameters:

ParameterTypeDescriptionRequiredSince

applyId

int64

No comments found.

true

-

applyId

string

No comments found.

false

-

Request-example:

curl -X GET -H 'Authorization' -i /com/file/v1/package/apply/download?applyId=gil.paucek --data '&gil.paucek&gil.paucek'

Response-example:

{}

60.12.删除文件

Type: DELETE

Author: Kaiser（wang shao）

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

Description: 删除文件

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Path-parameters:

ParameterTypeDescriptionRequiredSince

fileCode

string

文件编码

true

-

Request-example:

curl -X DELETE -H 'Authorization' -i /com/file/v1/88129

Response-fields:

FieldTypeDescriptionSince

code

int32

响应码

-

msg

string

响应消息

-

success

boolean

是否成功

-

data

string

响应数据

-

time

string

响应时间

-

Response-example:

{
  "code": 640,
  "msg": "428bzp",
  "success": true,
  "data": "mze1f2",
  "time": "2023-09-27 17:34:59"
}

60.13.批量删除文件

Type: DELETE

Author: Kaiser（wang shao）

Content-Type: application/json

Description: 批量删除文件

Request-headers:

HeaderTypeDescriptionRequiredSince

Authorization

String

Access Token

false

-

Body-parameters:

ParameterTypeDescriptionRequiredSince

fileCodes

array

文件编码,[array of string]

false

-

Request-example:

curl -X DELETE -H 'Content-Type: application/json' -H 'Authorization' -i /com/file/v1/delete --data '[
  "4hs5us"
]'

Response-fields:

FieldTypeDescriptionSince

code

int32

响应码

-

msg

string

响应消息

-

success

boolean

是否成功

-

data

array

响应数据

-

time

string

响应时间

-

Response-example:

{
  "code": 291,
  "msg": "1lbl6p",
  "success": true,
  "data": [
    "hgkgnn",
    "9bxdcm"
  ],
  "time": "2023-09-27 17:34:59"
}
Top