# API 接口文档

TIP

除了获取token接口外,其他请求请在请求头中写入 zk_main: token

# 用户接口

# 第三方接入获取token

  • 地址:http://localhost/service/zkview/user/thirdAccess
  • 类型:POST
  • 状态码:200
  • 简介:第三方平台传入用户手机号(或任意字符格式)和密码,如果没有该用户会自动注册,并获取token(zk_main),需手动将token写入请求头中{zk_main: token}
  • 请求接口格式:
{
    "phone": "testPhone",
    "password": "testPassword",
    "username": "testUser"
}
  • 返回接口格式:
{
    "status": true,
    "message": "接入成功",
    "data": {
        "userId": 3,
        "phone": "testPhone",
        "registerTime": 1669835979000,
        "lastVisitTime": 1669835979000,
        "onlineTime": 0,
        "useTimes": 1,
        "username": "testUser",
        "password": "testPassword",
        "header": null,
        "description": null,
        "declare": null,
        "stars": 0,
        "identity": 0,
        "coin": 0,
        "ticket": 0,
        "auth": "zk-view",
        "authList": [
            "zk-view"
        ],
        "zk_main": "eyJhbGciOiJSUzI1NiJ9.eyJhdXRoIjoie1wiYXV0aEluZm9MaXN0XCI6W3tcImF1dGhcIjpcInprLXZpZXdcIixcImF1dGhvcml0eVwiOlwiemstdmlld1wifV0sXCJhdXRoTGlzdFwiOltcInprLXZpZXdcIl0sXCJ0eXBlXCI6XCJlZGl0b3JcIixcInVzZXJJZFwiOjN9IiwianRpIjoiWkdFNFlUSTFNVFl0TjJSa05DMDBOVFJtTFRsbE9UZ3RORGczWkdJd1lUQm1OVGMyIiwiZXhwIjoxNjcxNTYzOTc5fQ.S3UHIk1Q33FOWNjRM1OFhBu8z1pKPvZn8oXXI9uv4aTqskmhPpMnkXGkK_RqzFAoV_4_GLDWoNKei73rvLPgLZpcSUVztYP52aBAM1UZDh8vc_415dZdHaQ79fAXrVqmwcHzKmwQ0qOPakw8OEf3oJifuurdXBMcOR6zCDrl8V_jpWK8mqLLISoT4zCKcJlLNO-jbJaVGoyEgPWeSEim8ITcb1rSehLm2YuL5AJGsJ8kQnKXYsz5PaE_WH4wC-z4d9ZHB5HQkh6NfB5jYx50_rKJEyf2zu-a9Tze92iZNBseNpT_qEcCJCUH51-ihv_XW7p_tI2iwadWhEpC7k_vyw"
    }
}

# 更改密码

  • 地址:http://localhost/service/zkview/user/updatePassword
  • 类型:POST
  • 状态码:200
  • 简介:无
  • 请求接口格式:
{
    "phone": "testPhone",
    "oldPassword": "testPassword",
    "newPassword": "testNewPassword"
}
  • 返回接口格式:
{
    "status": true,
    "message": "密码修改成功",
    "data": null
}

# 工作目录管理接口

# 查询所有的工作目录

  • 地址:http://localhost/service/zkview/work/getWork
  • 类型:POST
  • 状态码:200
  • 简介:无
  • 请求接口格式:
{}
  • 返回接口格式:
{
    "status": true,
    "message": "目录获取成功",
    "data": [
        {
            "workId": 1,
            "userId": 1,
            "name": "默认资源夹",
            "paper": false,
            "arrange": 0,
            "createTime": 1667924880633,
            "resourcesList": [],
            "load": false
        }
    ]
}

# 增加工作目录

  • 地址:http://localhost/service/zkview/work/addWork
  • 类型:POST
  • 状态码:200
  • 简介:无
  • 请求接口格式:
{
  "name": "元素目录5",
  "paper": false,
  "arrange": 100
}
  • 返回接口格式:
{
    "status": true,
    "message": "目录新建成功",
    "data": {
        "workId": 13,
        "userId": 1,
        "name": "元素目录5",
        "paper": false,
        "arrange": 100,
        "createTime": 1669900563418,
        "resourcesList": [],
        "load": false
    }
}

# 更改工作目录名称

  • 地址:http://localhost/service/zkview/work/renameWork
  • 类型:POST
  • 状态码:200
  • 简介:无
  • 请求接口格式:
{
    "userId": 1,
    "workId": 13,
    "name": "测试目录"
}
  • 返回接口格式:
{
    "status": true,
    "message": "目录更名成功",
    "data": null
}

# 删除工作目录

  • 地址:http://localhost/service/zkview/work/deleteWork
  • 类型:POST
  • 状态码:200
  • 简介:无
  • 请求接口格式:
{
    "workId": 13,
    "userId": 1
}
  • 返回接口格式:
{
    "status": true,
    "message": "目录删除成功",
    "data": null
}

# 元素图纸管理接口

# 查询工作目录下所有资源

  • 地址:http://localhost/service/zkview/work/getWorkResources
  • 类型:POST
  • 状态码:200
  • 简介:无
  • 请求接口格式:
{
    "workId": 1,
    "userId": 1
}
  • 返回接口格式:
{
    "status": true,
    "message": "资源获取成功",
    "data": [
        {
            "resourcesId": 11,
            "userId": 1,
            "createTime": 1669790084289,
            "updateTime": 1669872763150,
            "share": true,
            "name": "test",
            "type": "image",
            "suffix": "png",
            "saveName": "1f31ca50-b7d8-493d-84e8-00437f9dca9c",
            "savePath": "2022113014",
            "keywords": "test",
            "deleted": false,
            "description": "test",
            "publishPath": null,
            "download": 1,
            "money": 0,
            "valid": true,
            "coinAdd": 0.0,
            "ticketAdd": 0.0,
            "src": "2022113014/1f31ca50-b7d8-493d-84e8-00437f9dca9c.png",
            "srcP": "2022113014/1f31ca50-b7d8-493d-84e8-00437f9dca9c_p.png",
            "self": true,
            "selected": false,
            "arrange": null
        }
    ]
}

# 删除资源

  • 地址:http://localhost/service/zkview/resources/deleteResources
  • 类型:POST
  • 状态码:200
  • 简介:无
  • 请求接口格式:
{
    "resources": {
        "resourcesId": 12,
        "userId": 1
    },
    "workId": 1
}
  • 返回接口格式:
{
    "status": true,
    "message": "文件删除成功",
    "data": null
}

# 更改资源信息

  • 地址:http://localhost/service/zkview/resources/updateResourcesInfo
  • 类型:POST
  • 状态码:200
  • 简介:无
  • 请求接口格式:
{
    "resourcesId": 13,
    "userId": 1,
    "name": "test1",
    "keywords": "test",
    "description": "test",
    "share": false
}
  • 返回接口格式:
{
    "status": true,
    "message": "元素资料更新成功",
    "data": null
}

# 新建图纸

  • 地址:http://localhost/service/zkview/resources/addPaperResource
  • 类型:POST
  • 状态码:200
  • 简介:无
  • 请求接口格式:
{
    "name": "测试第三方图纸创建",
    "keywords": 1,
    "description": "test",
    "publishPath": "test",
    "workId": 2
}
  • 返回接口格式:
{
    "status": true,
    "message": "图纸新建成功",
    "data": {
        "resourcesId": 20,
        "userId": 1,
        "createTime": 1669900807969,
        "updateTime": 1669900807969,
        "share": false,
        "name": "测试第三方图纸创建",
        "type": "paper",
        "suffix": "png",
        "saveName": "b5194632-3557-4833-97f0-ef963a1a0e91",
        "savePath": "2022120121",
        "keywords": "1",
        "deleted": false,
        "description": "test",
        "publishPath": "test",
        "download": 0,
        "money": 0,
        "valid": true,
        "coinAdd": 0.0,
        "ticketAdd": 0.0,
        "src": "2022120121/b5194632-3557-4833-97f0-ef963a1a0e91.json",
        "srcP": "2022120121/b5194632-3557-4833-97f0-ef963a1a0e91_p.png",
        "self": true,
        "selected": false,
        "arrange": null
    }
}

# 资源获取接口

# 获取预览图片

  • 地址:http://localhost/service/zkview/fileStream/getFile/2022113014/1f31ca50-b7d8-493d-84e8-00437f9dca9c_p.png
  • 类型:GET
  • 状态码:200
  • 简介:无
  • 请求接口格式:
srcP: srcP
http://localhost/service/zkview/fileStream/getFile/ + srcP 
  • 返回接口格式:image/png

创建文件夹

# 获取原始图片

  • 地址:http://localhost/service/zkview/fileStream/getFile/2022113014/1f31ca50-b7d8-493d-84e8-00437f9dca9c.png
  • 类型:GET
  • 状态码:200
  • 简介:无
  • 请求接口格式:
src: src
http://localhost/service/zkview/fileStream/getFile/ + src
  • 返回接口格式:image/png

创建文件夹

# 获取预览图base64格式

  • 地址:http://localhost/service/zkview/fileStream/getImageBase64/2022112900/8324674d-fb47-4774-a846-0a77a3ceefcc_p.png
  • 类型:GET
  • 状态码:200
  • 简介:无
  • 请求接口格式:
srcP: srcP
http://localhost/service/zkview/fileStream/getImageBase64/ + srcP
  • 返回接口格式:
{
    "status": true,
    "message": "base64获取成功",
    "data": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAADgAAAAcCAYAAAA0u3w+AAAAAXNSR0IArs4c6QAAAGxJREFUWEft0rEVgCAUQ9EwiIVDa+mqeJwg7QMfdYr8XMZxzycbv/EdOJJryxtnTg9cWlbBpfmSKKggfAG/KByo1lOwTgQPKAgHqvUUrBPBAwrCgWo9BetE8ICCcKBaT8E6ETygIByo1vuD4AvOam8P1ydUeQAAAABJRU5ErkJggg=="
}

# 获取原图base64格式

  • 地址:http://localhost/service/zkview/fileStream/getImageBase64/2022112900/8324674d-fb47-4774-a846-0a77a3ceefcc.png
  • 类型:GET
  • 状态码:200
  • 简介:无
  • 请求接口格式:
src: src
http://localhost/service/zkview/fileStream/getImageBase64/ + src
  • 返回接口格式:
{
    "status": true,
    "message": "base64获取成功",
    "data": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAMwAAABoCAYAAAC9rx8KAAAAAXNSR0IArs4c6QAAAm9JREFUeF7t08EJwzAUBUGrEVfhWlVVepLBp0AIaM8en58PGv6Oc651+AgQ2BIYgtlyMiLwCHwHczEhQOCvwEcwroPAvoBg9q0sCRyCcQQEgoBgApYpAcG4AQJBQDABy5SAYNwAgSAgmIBlSkAwboBAEBBMwDIlIBg3QCAICCZgmRIQjBsgEAQEE7BMCQjGDRAIAoIJWKYEBOMGCAQBwQQsUwKCcQMEgoBgApYpAcG4AQJBQDABy5SAYNwAgSAgmIBlSkAwboBAEBBMwDIlIBg3QCAICCZgmRIQjBsgEAQEE7BMCQjGDRAIAoIJWKYEBOMGCAQBwQQsUwKCcQMEgoBgApYpAcG4AQJBQDABy5SAYNwAgSAgmIBlSkAwboBAEBBMwDIlIBg3QCAICCZgmRIQjBsgEAQEE7BMCQjGDRAIAoIJWKYEBOMGCAQBwQQsUwKCcQMEgoBgApYpAcG4AQJBQDABy5SAYNwAgSAgmIBlSkAwboBAEBBMwDIlIBg3QCAICCZgmRIQjBsgEAQEE7BMCQjGDRAIAoIJWKYEBOMGCAQBwQQsUwKCcQMEgoBgApYpAcG4AQJBQDABy5SAYNwAgSAgmIBlSkAwboBAEBBMwDIlIBg3QCAICCZgmRIQjBsgEAQEE7BMCQjGDRAIAoIJWKYEBOMGCAQBwQQsUwKCcQMEgoBgApYpAcG4AQJBQDABy5SAYNwAgSAgmIBlSkAwboBAEBBMwDIlIBg3QCAICCZgmRIQjBsgEAQEE7BMCQjGDRAIAoIJWKYEBOMGCAQBwQQsUwKCcQMEgsBPMOFfUwLvFBjnXOudT/dqAl3gBsEhfMjsu+g0AAAAAElFTkSuQmCC"
}

# 云部署管理接口

# 查询云部署列表

  • 地址:http://localhost/service/zkview/publish/getAllPublish
  • 类型:POST
  • 状态码:200
  • 简介:无
  • 请求接口格式:
{}
  • 返回接口格式:
{
    "status": true,
    "message": "云部署数据获取成功",
    "data": [
        {
            "resourcesId": 2,
            "userId": 1,
            "publishPath": "ddd",
            "authentication": false,
            "username": "",
            "password": null,
            "addTime": 1669795065011,
            "endTime": 1670399865011,
            "duration": 7,
            "token": "eyJhbGciOiJSUzI1NiJ9.eyJhdXRoIjoie1wiYXV0aEluZm9MaXN0XCI6W3tcImF1dGhcIjpcInprLXZpZXdcIixcImF1dGhvcml0eVwiOlwiemstdmlld1wifV0sXCJhdXRoTGlzdFwiOltcInprLXZpZXdcIl0sXCJ0eXBlXCI6XCJwdWJsaXNoXCIsXCJ1c2VySWRcIjoxfSIsImp0aSI6Ik9UYzNaRFZpWTJNdE5UQTJaaTAwWkRFekxXSmxaall0TURVMVkyUmxZemRqT1RFMSIsImV4cCI6MTY3MDM5OTg2NX0.hxDivvh85kyKqMseuFaIktatg4ZRos5S8J3WFvBOUrONex6BR6HWU0NkSVqFcxwV8s4SfgnPdvBVA4Fo_qbnTMxIAnKZTvwqUgHQFlOd9AJem_uPZ0cQq2NM07g1-L-zlSCYzp93y0z-6KVDG7C-lhXk0jbT7qk5OkbSiIprf0XkTWto_B7lI-xBUllCHX0YqOP81iLRMUnekzsxYqlKdyL5V8LLbv08_EpTJkzCUKdFWnZPgafu7r1Pows7ZvEldOdlsukxYEbmgk1WCq8RdXZELJ0ai1s6TNvL6VLlrndFi2vUciMf9jgR26PEFVThpzTaYgwfe9FfBrPXvxjIuA",
            "background": null,
            "title": null,
            "titleColor": null,
            "resources": {
                "resourcesId": 2,
                "userId": 1,
                "createTime": 1667925135261,
                "updateTime": 1667925138549,
                "share": true,
                "name": "啊啊啊",
                "type": "paper",
                "suffix": "png",
                "saveName": "5f538e74-adc9-40bd-a6a3-207a33b97d02",
                "savePath": "2022110900",
                "keywords": "是打发十分",
                "deleted": false,
                "description": "",
                "publishPath": "ddd",
                "download": 1,
                "money": 0,
                "valid": true,
                "coinAdd": 0.0,
                "ticketAdd": 0.0,
                "src": "2022110900/5f538e74-adc9-40bd-a6a3-207a33b97d02.json",
                "srcP": "2022110900/5f538e74-adc9-40bd-a6a3-207a33b97d02_p.png",
                "self": true,
                "selected": false,
                "arrange": null
            },
            "name": null
        }
    ]
}

# 更改云部署信息

  • 地址:http://localhost/service/zkview/publish/updatePublish
  • 类型:POST
  • 状态码:200
  • 简介:无
  • 请求接口格式:
{
    "resourcesId": 2,
    "userId": 1,
    "publishPath": "ddaaad",
    "authentication": true,
    "username": "abc",
    "password": "123456",
    "duration": 7,
    "background": "2022113014/c57c155e-467a-4d9d-b2b6-18a3c6b1a82d.png",
    "title": "测试云部署",
    "titleColor": "rgba(252, 252, 252, 1)"
}
  • 返回接口格式:
{
    "status": true,
    "message": "云部署更新成功",
    "data": null
}

# 删除云部署信息

  • 地址:http://localhost/service/zkview/publish/deletePublish/2

  • 类型:GET

  • 状态码:200

  • 简介:无

  • 请求接口格式:

  • 返回接口格式:

{
    "status": true,
    "message": "云部署删除成功",
    "data": null
}

# 添加云部署信息

  • 地址:
  • 类型:POST
  • 状态码:200
  • 简介:无
  • 请求接口格式:
{
    "resourcesId": 2,
    "publishPath": "dddabc",
    "authentication": true,
    "username": "abc",
    "password": "123456",
    "duration": 15,
    "token": null,
    "background": null,
    "title": null
}
  • 返回接口格式:
{
    "status": true,
    "message": "云部署信息添加成功",
    "data": null
}

# 云部署登录获取token

  • 地址:http://localhost/service/zkview/publish/publishLogin
  • 类型:POST
  • 状态码:200
  • 简介:无
  • 请求接口格式:
{
    "publishPath": "zzz",
    "username": "aaa",
    "password": "123456"
}
  • 返回接口格式:
{
    "status": true,
    "message": "登录成功",
    "data": {
        "resourcesId": 4,
        "userId": 1,
        "publishPath": "zzz",
        "authentication": true,
        "username": "aaa",
        "password": "123456",
        "addTime": 1669889830791,
        "endTime": 1671185830791,
        "duration": 15,
        "token": "eyJhbGciOiJSUzI1NiJ9.eyJhdXRoIjoie1wiYXV0aEluZm9MaXN0XCI6W3tcImF1dGhcIjpcInprLXZpZXdcIixcImF1dGhvcml0eVwiOlwiemstdmlld1wifV0sXCJhdXRoTGlzdFwiOltcInprLXZpZXdcIl0sXCJwYXNzd29yZFwiOlwiMTIzNDU2XCIsXCJ0eXBlXCI6XCJwdWJsaXNoXCIsXCJ1c2VySWRcIjoxLFwidXNlcm5hbWVcIjpcImFhYVwifSIsImp0aSI6Ik1qWTVPRFl3T1dNdE1XSTRPQzAwTVRjNUxUbGhaR1V0TnpZMFl6a3pNREJoT1RRNCIsImV4cCI6MTY3MTE4NTgzMH0.FWkGxZaW5CaLr819-6FKcS1zEAJFSuGENf3VzlyKxqRE5hNkoxF3jSrSTIOYsun7175in8uLjxzXq5U4B5Yc4BnBFyx9DiA31HraGQd4_bNG5KITaHA4Ct0bEKvpKr4iKkU5Kb-_NRayZue5_SOjFhKKMRZsxoKkMp4S9lnUB3kKNuQ4UxacxDXb0-52xMs9lqDEwafYUNbgocANbNrIcer-U4OJ7S77l_iWh_jwnaoqlaaIArCAskEMuuEGcfCg_7AyNt0XB4vGj5E5onKhnnPR8lS8jrejxzYYgxIkXUMODxpeyqF4vzdNpEKBZpqilNDNivhwYlHN8fj_B7ucmg",
        "background": null,
        "title": "",
        "titleColor": null,
        "resources": null,
        "name": null
    }
}

# 云分享管理接口

# 获取云分享列表

  • 地址:http://localhost/service/zkview/share/getAllShareLink
  • 类型:POST
  • 状态码:200
  • 简介:无
  • 请求接口格式:
{}
  • 返回接口格式:
{
    "status": true,
    "message": "分享资源获取成功",
    "data": [
        {
            "shareId": "292b29bd-635c-4493-9aaa-7ef928fd776d",
            "userId": 1,
            "resourcesIds": "7",
            "code": "a741",
            "validDays": 30,
            "addTime": 1669788805194,
            "endTime": 1672380805194,
            "resourcesList": [
                {
                    "resourcesId": 7,
                    "userId": 1,
                    "createTime": 1669652052914,
                    "updateTime": 1669652052914,
                    "share": true,
                    "name": "发啊",
                    "type": "image",
                    "suffix": "png",
                    "saveName": "8324674d-fb47-4774-a846-0a77a3ceefcc",
                    "savePath": "2022112900",
                    "keywords": "发生的",
                    "deleted": false,
                    "description": null,
                    "publishPath": null,
                    "download": 1,
                    "money": 0,
                    "valid": true,
                    "coinAdd": 0.0,
                    "ticketAdd": 0.0,
                    "src": "2022112900/8324674d-fb47-4774-a846-0a77a3ceefcc.png",
                    "srcP": "2022112900/8324674d-fb47-4774-a846-0a77a3ceefcc_p.png",
                    "self": true,
                    "selected": false,
                    "arrange": null
                }
            ]
        }
    ]
}

# 更新云分享信息

  • 地址:http://localhost/service/zkview/share/updateShare
  • 类型:POST
  • 状态码:200
  • 简介:无
  • 请求接口格式:
{
    "shareId": "67ca5410-09e2-4dd1-80c7-174f6715a8f7",
    "code": "5555",
    "validDays": 30
}
// 可选值 validDays 可选值: 
[
  { name: '1天', value: 1 }, 
  { name: '7天', value: 7 }, 
  { name: '15天', value: 15 }, 
  { name: '1个月', value: 30 }, 
  { name: '3个月', value: 90 }, 
  { name: '6个月', value: 180 }, 
  { name: '1年', value: 365 }, 
  { name: '3年', value: 1095 }, 
  { name: '永久', value: 36500 }
]
  • 返回接口格式:
{
    "status": true,
    "message": "分享资源更新成功",
    "data": null
}

# 添加云分享信息

  • 地址:http://localhost/service/zkview/share/addSharelink
  • 类型:POST
  • 状态码:200
  • 简介:无
  • 请求接口格式:
{
    "resourcesIds": "2",
    "code": "d004",
    "validDays": 15
}
// 可选值 validDays 可选值: 
[
  { name: '1天', value: 1 }, 
  { name: '7天', value: 7 }, 
  { name: '15天', value: 15 }, 
  { name: '1个月', value: 30 }, 
  { name: '3个月', value: 90 }, 
  { name: '6个月', value: 180 }, 
  { name: '1年', value: 365 }, 
  { name: '3年', value: 1095 }, 
  { name: '永久', value: 36500 }
]
  • 返回接口格式:
{
    "status": true,
    "message": "资源分享成功",
    "data": {
        "shareId": "6776fd18-1878-40bb-b951-103c68e64916",
        "userId": 1,
        "resourcesIds": "2",
        "code": "d004",
        "validDays": 15,
        "addTime": 1669887023125,
        "endTime": 1671183023125,
        "resourcesList": null
    }
}

# 删除云分享

  • 地址:http://localhost/service/zkview/share/deleteShare/bf72f24a-bb57-4695-a1d3-1317835a2dba
  • 类型:GET
  • 状态码:200
  • 简介:无
  • 请求接口格式:
shareId: shareId
http://localhost/service/zkview/share/deleteShare/ + shareId
  • 返回接口格式:
{
    "status": true,
    "message": "分享资源删除成功",
    "data": null
}

# 数据源管理接口

# 获取所有数据源

  • 地址:http://localhost/service/zkview/datasource/getAllDatasource

  • 类型:GET

  • 状态码:200

  • 简介:无

  • 请求接口格式:

  • 返回接口格式:

{
    "status": true,
    "message": "数据源项目获取成功",
    "data": [
        {
            "datasourceId": 5,
            "userId": 5,
            "arrange": 1000,
            "name": "区域一",
            "createTime": 1672568279331,
            "description": "区域一介绍",
            "sourceList": [
                {
                    "sourceId": 5,
                    "datasourceId": 5,
                    "arrange": 1000,
                    "name": "园区1",
                    "url": "ws://localhost:9601/zkSource",
                    "sourceKey": "yq1",
                    "script": "",
                    "manageUrl": "",
                    "createTime": 1672574596039,
                    "description": "园区1数据源",
                    "pointList": null
                }
            ]
        },
        {
            "datasourceId": 6,
            "userId": 5,
            "arrange": 1000,
            "name": "测试数据源",
            "createTime": 1672593074318,
            "description": "测试数据源介绍",
            "sourceList": []
        },
        {
            "datasourceId": 7,
            "userId": 5,
            "arrange": 1000,
            "name": "测试数据源",
            "createTime": 1672593114529,
            "description": "测试数据源介绍",
            "sourceList": []
        }
    ]
}

# 添加数据源工程

  • 地址:http://localhost/service/zkview/datasource/addDatasource
  • 类型:POST
  • 状态码:200
  • 简介:无
  • 请求接口格式:
{
  "name": "测试数据源",
  "description": "测试数据源介绍"
}
  • 返回接口格式:
{
    "status": true,
    "message": "数据源项目添加成功",
    "data": null
}

# 更新数据源工程

  • 地址:http://localhost/service/zkview/datasource/updateDatasource
  • 类型:POST
  • 状态码:200
  • 简介:无
  • 请求接口格式:
{
  "datasourceId": 6,
  "userId": 5,
  "arrange": 1000,
  "name": "测试数据源修改",
  "createTime": 1672593074318,
  "description": "测试数据源介绍",
  "sourceList": []
}
  • 返回接口格式:
{
    "status": true,
    "message": "数据源项目更新成功",
    "data": null
}

# 删除数据源工程

  • 地址:http://localhost/service/zkview/datasource/deleteDatasource
  • 类型:POST
  • 状态码:200
  • 简介:无
  • 请求接口格式:
{
  "datasourceId": 7,
  "userId": 5,
  "arrange": 1000,
  "name": "测试数据源",
  "createTime": 1672593114529,
  "description": "测试数据源介绍",
  "sourceList": []
}
  • 返回接口格式:
{
    "status": true,
    "message": "数据源项目删除成功",
    "data": null
}

# 添加数据源

  • 地址:http://localhost/service/zkview/datasource/addSource
  • 类型:POST
  • 状态码:200
  • 简介:无
  • 请求接口格式:
{
  "datasourceId": 5,
  "name": "添加测试数据源",
  "description": "添加测试数据源介绍",
  "url": "ws://localhost:10061/zkSourdce",
  "sourceKey": "test1",
  "script": "console.log('test script')",
  "manageUrl": "http://localhost:10061"
}
  • 返回接口格式:
{
    "status": true,
    "message": "数据源添加成功",
    "data": null
}

# 更新数据源

  • 地址:http://localhost/service/zkview/datasource/updateSource
  • 类型:POST
  • 状态码:200
  • 简介:无
  • 请求接口格式:
{
  "sourceId": 7,
  "datasourceId": 5,
  "arrange": 1000,
  "name": "添加测试数据源修改",
  "url": "ws://localhost:10061/zkSourdce",
  "sourceKey": "test1",
  "script": "console.log('test script')",
  "manageUrl": "http://localhost:10061",
  "createTime": 1672593516915,
  "description": "添加测试数据源介绍",
  "pointList": null
}
  • 返回接口格式:
{
    "status": true,
    "message": "数据源更新成功",
    "data": null
}

# 删除数据源

  • 地址:http://localhost/service/zkview/datasource/deleteSource
  • 类型:POST
  • 状态码:200
  • 简介:无
  • 请求接口格式:
{
  "sourceId": 7,
  "datasourceId": 5,
  "arrange": 1000,
  "name": "添加测试数据源修改",
  "url": "ws://localhost:10061/zkSourdce",
  "sourceKey": "test1",
  "script": "console.log('test script')",
  "manageUrl": "http://localhost:10061",
  "createTime": 1672593516915,
  "description": "添加测试数据源介绍",
  "pointList": null
}
  • 返回接口格式:
{
    "status": true,
    "message": "数据源删除成功",
    "data": null
}

# 获取数据源下的所有测点

  • 地址:http://localhost/service/zkview/datasource/getPointBySourceId
  • 类型:POST
  • 状态码:200
  • 简介:无
  • 请求接口格式:
{
  "sourceId": 6,
  "datasourceId": 5,
  "arrange": 1000,
  "name": "添加测试数据源",
  "url": "ws://localhost:9601/zkSource",
  "sourceKey": "test1",
  "script": "console.log('test script')",
  "manageUrl": "http://localhost:10061",
  "createTime": 1672593496855,
  "description": "添加测试数据源介绍",
  "pointList": null
}
  • 返回接口格式:
{
    "status": true,
    "message": "测点列表获取成功",
    "data": [
        {
            "pointId": 16,
            "sourceId": 6,
            "sourceKey": null,
            "pointKey": "num_1_1",
            "createTime": 1672593795544,
            "arrange": 1000,
            "type": 0,
            "script": null,
            "name": null,
            "handle": null,
            "value": null
        },
        {
            "pointId": 17,
            "sourceId": 6,
            "sourceKey": null,
            "pointKey": "num_1_2",
            "createTime": 1672593795544,
            "arrange": 1000,
            "type": 0,
            "script": null,
            "name": null,
            "handle": null,
            "value": null
        },
        {
            "pointId": 18,
            "sourceId": 6,
            "sourceKey": null,
            "pointKey": "num_10_5",
            "createTime": 1672593795544,
            "arrange": 1000,
            "type": 0,
            "script": null,
            "name": null,
            "handle": null,
            "value": null
        },
        {
            "pointId": 19,
            "sourceId": 6,
            "sourceKey": null,
            "pointKey": "num_100_1",
            "createTime": 1672593795544,
            "arrange": 1000,
            "type": 0,
            "script": null,
            "name": null,
            "handle": null,
            "value": null
        },
        {
            "pointId": 20,
            "sourceId": 6,
            "sourceKey": null,
            "pointKey": "num_1000_1",
            "createTime": 1672593795544,
            "arrange": 1000,
            "type": 0,
            "script": null,
            "name": null,
            "handle": null,
            "value": null
        },
        {
            "pointId": 21,
            "sourceId": 6,
            "sourceKey": null,
            "pointKey": "list_10_1",
            "createTime": 1672593795544,
            "arrange": 1000,
            "type": 0,
            "script": null,
            "name": null,
            "handle": null,
            "value": null
        },
        {
            "pointId": 22,
            "sourceId": 6,
            "sourceKey": null,
            "pointKey": "list_100_1",
            "createTime": 1672593795544,
            "arrange": 1000,
            "type": 0,
            "script": null,
            "name": null,
            "handle": null,
            "value": null
        },
        {
            "pointId": 23,
            "sourceId": 6,
            "sourceKey": null,
            "pointKey": "text_1",
            "createTime": 1672593795544,
            "arrange": 1000,
            "type": 0,
            "script": null,
            "name": null,
            "handle": null,
            "value": null
        },
        {
            "pointId": 24,
            "sourceId": 6,
            "sourceKey": null,
            "pointKey": "img_1",
            "createTime": 1672593795544,
            "arrange": 1000,
            "type": 0,
            "script": null,
            "name": null,
            "handle": null,
            "value": null
        },
        {
            "pointId": 25,
            "sourceId": 6,
            "sourceKey": null,
            "pointKey": "sum1_2",
            "createTime": 1672593799754,
            "arrange": 1000,
            "type": 1,
            "script": "return data['num_1_1'] + data['num_1_2']",
            "name": "求和点1",
            "handle": null,
            "value": null
        }
    ]
}

# 更新数据源的测点信息(增删改)

  • 地址:http://localhost/service/zkview/datasource/updatePointList
  • 类型:POST
  • 状态码:200
  • 简介:无
  • 请求接口格式:
[
  {
    "pointId": 19,
    "sourceId": 6,
    "sourceKey": null,
    "pointKey": "num_100_1",
    "createTime": 1672593795544,
    "arrange": 1000,
    "type": 0,
    "script": null,
    "name": null,
    "handle": "delete",
    "value": 75.6374
  },
  {
    "pointId": 25,
    "sourceId": 6,
    "sourceKey": null,
    "pointKey": "sum1_2",
    "createTime": 1672593799754,
    "arrange": 1000,
    "type": 1,
    "script": "return data['num_1_1'] + data['num_1_2'] * 2",
    "name": "求和点1修改",
    "handle": "update",
    "value": null
  },
  {
    "sourceId": 6,
    "pointKey": "num_10_5",
    "createTime": 1672594051173,
    "type": 0,
    "selected": true,
    "handle": "add"
  }
]
  • 返回接口格式:
{
    "status": true,
    "message": "测点更新成功",
    "data": null
}