乐投在线登录-乐投(中国)数字孪生平台SpatialManager API文档 (3.56.0)

[openapiV3]-项目管理接口

查询项目信息

查询项目相关信息接口

path Parameters
projectId
required
integer <int64>

项目ID

Responses

修改项目

修改项目接口

path Parameters
projectId
required
integer <int64>

项目ID

Request Body schema: application/json
required
name
string

项目名称

description
string

描述

thumbnailId
string

缩略图文件存储ID

thumbnailUrl
string

缩略图URL

object

项目空间坐标信息

projectId
integer <int64>

项目ID

Responses

Request samples

Content type
application/json
{}

删除项目

删除项目接口

path Parameters
projectId
required
integer <int64>

项目ID

Responses

创建项目

创建新的项目接口

Request Body schema: application/json
required
name
string

项目名称

description
string

描述

thumbnailId
string

缩略图文件存储ID

thumbnailUrl
string

缩略图URL

object

项目空间坐标信息

projectId
integer <int64>

项目ID

Responses

Request samples

Content type
application/json
{}

MVT服务openAPIV3

编辑mvt服务

编辑mvt服务

path Parameters
projectId
required
integer <int64>

项目ID

categoryId
required
integer <int64>

专题分类ID

id
required
integer <int64>
Request Body schema: application/json
required
name
required
string non-empty

服务名称

oldDirIds
string

专题id-目录id,英文逗号隔开

dirIds
string

专题id-目录id,英文逗号隔开

serviceTags
Array of strings

标签,json数组格式

description
string

服务描述

required
Array of objects (MVTPublishReqSubLayer) non-empty

子服务列表, 如不修改传入原来的数据

minZoom
integer <int32>

最小层级

maxZoom
integer <int32>

最大层级

style
string

样式json字符串

styleExtConfig
string

样式扩展配置, json字符串

Responses

Request samples

Content type
application/json
{
  • "name": "mvt服务",
  • "oldDirIds": "3-1,2-3",
  • "dirIds": "3-1,2-3,4-7",
  • "serviceTags": [
    ],
  • "description": "abc",
  • "subLayers": [
    ],
  • "minZoom": 0,
  • "maxZoom": 0,
  • "style": "string",
  • "styleExtConfig": "string"
}

发布mvt服务

发布mvt服务

path Parameters
projectId
required
integer <int64>

项目ID

categoryId
required
integer <int64>

专题分类ID

Request Body schema: application/json
required
id
integer <int64>

服务id, 预发布时候的服务id, 如果直接发布可以为空

name
required
string non-empty

服务名称

categoryId
required
integer <int64>

专题id

dirId
required
integer <int64>

目录id

required
Array of objects (MVTPublishReqSubLayer) non-empty

子服务列表

serviceTags
Array of strings

服务标签

description
string

服务描述

style
string

样式json字符串

styleExtConfig
string

样式扩展配置, json字符串

initCache
boolean

是否初始化缓存

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "categoryId": 0,
  • "dirId": 0,
  • "subLayers": [
    ],
  • "serviceTags": [
    ],
  • "description": "string",
  • "style": "string",
  • "styleExtConfig": "string",
  • "initCache": true
}

预发布mvt服务

预发布mvt服务,获得可以临时使用的mvt服务

path Parameters
projectId
required
integer <int64>

项目ID

categoryId
required
integer <int64>

专题分类ID

Request Body schema: application/json
required
name
required
string non-empty

服务名称

featureClassIds
required
Array of integers <int64> non-empty [ items <int64 > ]

要素类id数组

Responses

Request samples

Content type
application/json
{
  • "name": "mvt服务",
  • "featureClassIds": [
    ]
}

dwg文件发布mvt服务

dwg文件发布mvt服务接口,会自动适配dwg中的layer生成合理的也样式

path Parameters
projectId
required
integer <int64>

项目ID

categoryId
required
integer <int64>

专题分类ID

Request Body schema: application/json
required
id
integer <int64>

服务id, 预发布时候的服务id, 如果直接发布可以为空

name
required
string non-empty

服务名称

categoryId
required
integer <int64>

专题id

dirId
required
integer <int64>

目录id

serviceTags
Array of strings

服务标签

description
string

服务描述

fileVersionId
required
string non-empty

dwg文件versionId

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "categoryId": 0,
  • "dirId": 0,
  • "serviceTags": [
    ],
  • "description": "string",
  • "fileVersionId": "100001"
}

获取mvt图层中指定要素id的几何信息

获取mvt图层中指定要素id的几何信息

path Parameters
projectId
required
integer <int64>

项目id

serviceId
required
integer <int64>

mvt服务id

query Parameters
layerId
required
string
featureId
required
integer <int32>

要素id

Responses

获取mvt线图标

获取mvt线图标

path Parameters
projectId
required
integer <int64>

项目ID

categoryId
required
integer <int64>

专题分类ID

Responses

[openapiV2]-场景管理API接口

更新场景(场景保存和场景发布调用)

更新场景(场景保存和场景发布调用,通过partSave区分来源,true代表是场景图层面板的局部保存;false代表场景发布接口,默认false)

path Parameters
projectId
required
integer <int64>

项目ID

sceneId
required
integer <int64>

场景ID

Request Body schema: application/json
required
partSave
boolean

true代表是场景图层面板的局部保存;false代表场景发布接口,默认false

name
string

场景名称

description
string

项目名称

sceneSubjectId
required
integer <int64>

场景主题ID,不传入不需要更新

supportQuery
boolean

true代表是设置、修改或者删除支持查询的服务ID类型的更新;false代表普通场景更新接口,默认false

layersSupportQuery
string

场景支持查询的服务ID,用逗号分割;新增和更新均为全量设置,如果传入为空''、或者null,可移执行,代表删除

object (SceneConfig)

场景参数

Responses

Request samples

Content type
application/json
{
  • "partSave": false,
  • "name": "场景一",
  • "description": "活动场景",
  • "sceneSubjectId": 2410285784358944,
  • "supportQuery": false,
  • "layersSupportQuery": "2415730200543424,2418965879554240",
  • "config": {
    }
}

跨场景主题移动场景

跨场景主题移动场景接口

path Parameters
projectId
required
integer <int64>

项目ID

sceneId
required
integer <int64>

场景ID

Request Body schema: application/json
required
sceneSubjectId
required
integer <int64>

场景主题ID,不传入后台使用项目默认场景主题ID

Responses

Request samples

Content type
application/json
{
  • "sceneSubjectId": 2410285784358944
}

复制场景V2

复制场景接口

path Parameters
projectId
required
integer <int64>

项目ID

sceneId
required
integer <int64>

源场景ID

Request Body schema: application/json
required
creatTime
integer <int64>

创建时间

name
required
string

场景名称

Responses

Request samples

Content type
application/json
{
  • "creatTime": 123,
  • "name": "场景复制新"
}

上传初始视角截图

场景创建和编辑-上传初始视角截图

path Parameters
projectId
required
integer <int64>
sceneId
required
integer <int64>

场景ID

Request Body schema: application/json
file
required
string <binary>

Responses

Request samples

Content type
application/json
{
  • "file": "string"
}

获取3dtiles批量图层属性

获取3dtiles批量图层属性

path Parameters
projectId
required
integer <int64>
sceneId
required
integer <int64>

场景ID

Request Body schema: application/json
required
Array
string

Responses

Request samples

Content type
application/json
[
  • "string"
]

复制场景

复制场景接口

path Parameters
projectId
required
integer <int64>

项目ID

sceneId
required
integer <int64>

源场景ID

Responses

通过服务ID获取图层属性

通过服务ID获取图层属性接口

path Parameters
projectId
required
integer <int64>

项目ID

Request Body schema: application/json
required
Array
dataServiceId
integer <int64>

服务ID;group true

group
boolean

是否是获取组信息,默认false;group时为true

folderName
string

group时为true,该字段不能为空

Responses

Request samples

Content type
application/json
[
  • {
    }
]

通过服务ID获取图层属性

通过服务ID获取图层属性接口

path Parameters
projectId
required
integer <int64>

项目ID

Request Body schema: application/json
required
Array
dataServiceId
integer <int64>

服务ID;group true

group
boolean

是否是获取组信息,默认false;group时为true

folderName
string

group时为true,该字段不能为空

layerType
integer <int32>

图层类型

Responses

Request samples

Content type
application/json
[
  • {
    }
]

删除校验

删除校验接口

path Parameters
projectId
required
integer <int64>

项目ID

Request Body schema: application/json
required
Array
integer <int64>

Responses

Request samples

Content type
application/json
[
  • 0
]

新建场景(保存场景数据和场景配置数据)

新建场景(保存场景数据和场景配置数据)接口

path Parameters
projectId
required
integer <int64>

项目ID

Request Body schema: application/json
required
sceneSubjectId
required
integer <int64>

场景主题ID,不传入后台使用项目默认场景主题ID

Responses

Request samples

Content type
application/json
{
  • "sceneSubjectId": 2410285784358944
}

场景列表--不分页

查询项目下的所有场景接口

path Parameters
projectId
required
integer <int64>

项目ID

query Parameters
name
string

场景名称(包含)

sceneSubjectId
integer <int64>

场景主题ID

createTimeFrom
integer <int64>

创建时间(开始)

createTimeTo
integer <int64>

创建时间(结束)

isCreate
string
Default: null

是否按创建时间排序,false就按更新时间

isDesc
string
Default: null

是否按降序排序

header Parameters
x-tenant-id
required
integer <int64>
x-user-id
required
string

Responses

批量删除场景

批量删除场景接口

path Parameters
projectId
required
integer <int64>

项目ID

Request Body schema: application/json
required
Array
integer <int64>

Responses

Request samples

Content type
application/json
[
  • 0
]

获取场景缩略图

获取场景缩略图

path Parameters
projectId
required
integer <int64>

项目ID

sceneId
required
integer <int64>

源场景ID

Responses

查询场景详情(场景信息和配置详情)

查询场景详情(场景信息和配置详情)接口

path Parameters
projectId
required
integer <int64>

项目ID

sceneId
required
integer <int64>

场景ID

query Parameters
viewToken
string

分享获取场景要加viewToken:场景查看校验用的token

from
string
Default: null

获取详情接口调用来源:枚举值: edit-编辑 get-预览 share-共享 simple-只是获取基础信息(不包含config),edit时需要对整个场景做一个缓存,用于取消时还原场景配置;share时需要传入viewToken

Responses

取消场景编辑

查询场景详情(场景信息和配置详情)接口

path Parameters
projectId
required
integer <int64>

项目ID

sceneId
required
integer <int64>

场景ID

query Parameters
from
string
Default: null

new代表场景更新来源于新建场景跳转;edit代表编辑的时候调用更新接口;默认是edit

Responses

场景列表--分页

查询项目下的所有场景接口

path Parameters
projectId
required
integer <int64>

项目ID

query Parameters
name
string

场景名称(包含)

sceneSubjectId
integer <int64>

场景主题ID

createTimeFrom
integer <int64>

创建时间(开始)

createTimeTo
integer <int64>

创建时间(结束)

pageIndex
integer <int32>
Default: 1

当前页

pageSize
integer <int32>
Default: 10

每页数量

isCreate
string
Default: null

是否按创建时间排序,false就按更新时间

isDesc
string
Default: null

是否按降序排序

header Parameters
x-tenant-id
required
integer <int64>
x-user-id
required
string

Responses

删除场景

删除场景接口

path Parameters
projectId
required
integer <int64>

项目ID

sceneId
required
integer <int64>

场景ID

Responses

[openapi]-translate-file-转换文件API接口

转换文件

请求体参见模型 OpenApiTranslateReq(含 sources、config、callback 等字段)

path Parameters
projectId
required
integer <int64>

项目ID

Request Body schema: application/json
required
required
Array of objects (TranslateSourceReq) non-empty

源文件信息

object

完整的配置信息

object

文本框输入的配置信息

autoPublished
boolean

是否自动发布

serviceType
integer <int32>

服务类型

callback
string

回调地址

Responses

Request samples

Content type
application/json
{
  • "sources": [
    ],
  • "config": {
    },
  • "originTranslateConfig": {
    },
  • "autoPublished": true,
  • "serviceType": 1,
}

[openapi]-style-management-样式管理openAPI接口

样式详情

样式详情接口

path Parameters
projectId
required
integer <int64>

项目Id

styleId
required
integer <int64>

样式Id

Responses

更新样式

更新样式接口

path Parameters
projectId
required
integer <int64>

项目Id

styleId
required
integer <int64>

样式Id

Request Body schema: application/json
required
projectId
integer <int64>

所属项目id

name
required
string non-empty

样式名称

description
string

样式描述

content
required
string non-empty

样式具体内容[json字符串]

exConfig
string

样式额外配置[json字符串]

object (SpriteReq)

是否需要生成雪碧图

Responses

Request samples

Content type
application/json
{
  • "projectId": 123,
  • "name": "特殊点",
  • "description": "专题图样式",
  • "content": "string",
  • "exConfig": "string",
  • "generateSprite": true
}

删除样式

删除样式接口

path Parameters
projectId
required
integer <int64>

项目Id

styleId
required
integer <int64>

样式Id

Responses

样式列表

样式列表查询接口

path Parameters
projectId
required
integer <int64>

项目Id

query Parameters
name
string

样式名称

styleType
integer <int32>

样式类型

styleSource
integer <int32>

样式来源

pageIndex
integer <int32>
Default: 1

页码

pageSize
integer <int32>
Default: 10

每页数量

isCreate
string
Default: null

是否按创建时间排序,false就按更新时间

isDesc
string
Default: null

是否按降序排序

header Parameters
x-tenant-id
required
integer <int64>
x-user-id
required
string

Responses

添加样式

添加样式接口

path Parameters
projectId
required
integer <int64>

项目Id

Request Body schema: application/json
required
projectId
integer <int64>

所属项目id

name
required
string non-empty

样式名称

description
string

样式描述

content
required
string non-empty

样式具体内容[json字符串]

exConfig
string

样式额外配置[json字符串]

object (SpriteReq)

是否需要生成雪碧图

Responses

Request samples

Content type
application/json
{
  • "projectId": 123,
  • "name": "特殊点",
  • "description": "专题图样式",
  • "content": "string",
  • "exConfig": "string",
  • "generateSprite": true
}

上传并导入样式

上传样式

path Parameters
projectId
required
integer <int64>

项目Id

query Parameters
styleSource
required
integer <int32>
Example: styleSource=1

样式来源

styleType
integer <int32>
Example: styleType=1

样式类型,如果来源是idesktop, 那必须有

Request Body schema: application/json
file
required
string <binary>

Responses

Request samples

Content type
application/json
{
  • "file": "string"
}

批量删除样式

批量删除样式接口

path Parameters
projectId
required
integer <int64>

项目Id

Request Body schema: application/json
required
ids
required
Array of integers <int64> [ items <int64 > ]

样式id集合

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ]
}

样式批量下载

样式批量下载接口

path Parameters
projectId
required
integer <int64>

项目Id

query Parameters
ids
required
string
Example: ids=1,2,3

样式id集合,使用[,]分隔

Responses

创建样式时获取可用的名称

创建样式时获取可用的名称

path Parameters
projectId
required
integer <int64>

项目Id

query Parameters
name
required
string

样式名称

Responses

[openapi]-scene-management-场景管理API接口

更新场景(场景保存和场景发布调用)

更新场景(场景保存和场景发布调用,通过partSave区分来源,true代表是场景图层面板的局部保存;false代表场景发布接口,默认false)

path Parameters
projectId
required
integer <int64>

项目ID

sceneId
required
integer <int64>

场景ID

Request Body schema: application/json
required
partSave
boolean

true代表是场景图层面板的局部保存;false代表场景发布接口,默认false

name
string

场景名称

description
string

项目名称

sceneSubjectId
required
integer <int64>

场景主题ID,不传入不需要更新

supportQuery
boolean

true代表是设置、修改或者删除支持查询的服务ID类型的更新;false代表普通场景更新接口,默认false

layersSupportQuery
string

场景支持查询的服务ID,用逗号分割;新增和更新均为全量设置,如果传入为空''、或者null,可移执行,代表删除

object (SceneConfig)

场景参数

Responses

Request samples

Content type
application/json
{
  • "partSave": false,
  • "name": "场景一",
  • "description": "活动场景",
  • "sceneSubjectId": 2410285784358944,
  • "supportQuery": false,
  • "layersSupportQuery": "2415730200543424,2418965879554240",
  • "config": {
    }
}

跨场景主题移动场景

跨场景主题移动场景接口

path Parameters
projectId
required
integer <int64>

项目ID

sceneId
required
integer <int64>

场景ID

Request Body schema: application/json
required
sceneSubjectId
required
integer <int64>

场景主题ID,不传入后台使用项目默认场景主题ID

Responses

Request samples

Content type
application/json
{
  • "sceneSubjectId": 2410285784358944
}

复制场景V2

复制场景接口

path Parameters
projectId
required
integer <int64>

项目ID

sceneId
required
integer <int64>

源场景ID

Request Body schema: application/json
required
creatTime
integer <int64>

创建时间

name
required
string

场景名称

Responses

Request samples

Content type
application/json
{
  • "creatTime": 123,
  • "name": "场景复制新"
}

复制场景

复制场景接口

path Parameters
projectId
required
integer <int64>

项目ID

sceneId
required
integer <int64>

源场景ID

Responses

上传初始视角截图

场景创建和编辑-上传初始视角截图

path Parameters
projectId
required
integer <int64>
sceneId
required
integer <int64>

场景ID

Request Body schema: application/json
file
required
string <binary>

Responses

Request samples

Content type
application/json
{
  • "file": "string"
}

获取3dtiles批量图层属性

获取3dtiles批量图层属性

path Parameters
projectId
required
integer <int64>
sceneId
required
integer <int64>

场景ID

Request Body schema: application/json
required
Array
string

Responses

Request samples

Content type
application/json
[
  • "string"
]

通过服务ID获取图层属性

通过服务ID获取图层属性接口

path Parameters
projectId
required
integer <int64>

项目ID

Request Body schema: application/json
required
Array
dataServiceId
integer <int64>

服务ID;group true

group
boolean

是否是获取组信息,默认false;group时为true

folderName
string

group时为true,该字段不能为空

Responses

Request samples

Content type
application/json
[
  • {
    }
]

新建场景(保存场景数据和场景配置数据)

新建场景(保存场景数据和场景配置数据)接口

path Parameters
projectId
required
integer <int64>

项目ID

Request Body schema: application/json
required
sceneSubjectId
required
integer <int64>

场景主题ID,不传入后台使用项目默认场景主题ID

Responses

Request samples

Content type
application/json
{
  • "sceneSubjectId": 2410285784358944
}

通过服务ID获取图层属性

通过服务ID获取图层属性接口

path Parameters
projectId
required
integer <int64>

项目ID

Request Body schema: application/json
required
Array
dataServiceId
integer <int64>

服务ID;group true

group
boolean

是否是获取组信息,默认false;group时为true

folderName
string

group时为true,该字段不能为空

layerType
integer <int32>

图层类型

Responses

Request samples

Content type
application/json
[
  • {
    }
]

删除校验

删除校验接口

path Parameters
projectId
required
integer <int64>

项目ID

Request Body schema: application/json
required
Array
integer <int64>

Responses

Request samples

Content type
application/json
[
  • 0
]

场景列表--不分页

查询项目下的所有场景接口

path Parameters
projectId
required
integer <int64>

项目ID

query Parameters
name
string

场景名称(包含)

sceneSubjectId
integer <int64>

场景主题ID

createTimeFrom
integer <int64>

创建时间(开始)

createTimeTo
integer <int64>

创建时间(结束)

isCreate
string
Default: null

是否按创建时间排序,false就按更新时间

isDesc
string
Default: null

是否按降序排序

header Parameters
x-tenant-id
required
integer <int64>
x-user-id
required
string

Responses

批量删除场景

批量删除场景接口

path Parameters
projectId
required
integer <int64>

项目ID

Request Body schema: application/json
required
Array
integer <int64>

Responses

Request samples

Content type
application/json
[
  • 0
]

获取场景缩略图

获取场景缩略图

path Parameters
projectId
required
integer <int64>

项目ID

sceneId
required
integer <int64>

源场景ID

Responses

查询场景详情(场景信息和配置详情)

查询场景详情(场景信息和配置详情)接口

path Parameters
projectId
required
integer <int64>

项目ID

sceneId
required
integer <int64>

场景ID

query Parameters
viewToken
string

分享获取场景要加viewToken:场景查看校验用的token

from
string
Default: null

获取详情接口调用来源:枚举值: edit-编辑 get-预览 share-共享 simple-只是获取基础信息(不包含config),edit时需要对整个场景做一个缓存,用于取消时还原场景配置;share时需要传入viewToken

Responses

取消场景编辑

查询场景详情(场景信息和配置详情)接口

path Parameters
projectId
required
integer <int64>

项目ID

sceneId
required
integer <int64>

场景ID

query Parameters
from
string
Default: null

new代表场景更新来源于新建场景跳转;edit代表编辑的时候调用更新接口;默认是edit

Responses

场景列表--分页

查询项目下的所有场景接口

path Parameters
projectId
required
integer <int64>

项目ID

query Parameters
name
string

场景名称(包含)

sceneSubjectId
integer <int64>

场景主题ID

createTimeFrom
integer <int64>

创建时间(开始)

createTimeTo
integer <int64>

创建时间(结束)

pageIndex
integer <int32>
Default: 1

当前页

pageSize
integer <int32>
Default: 10

每页数量

isCreate
string
Default: null

是否按创建时间排序,false就按更新时间

isDesc
string
Default: null

是否按降序排序

header Parameters
x-tenant-id
required
integer <int64>
x-user-id
required
string

Responses

删除场景

删除场景接口

path Parameters
projectId
required
integer <int64>

项目ID

sceneId
required
integer <int64>

场景ID

Responses

[openapi]-feature-class-要素集|要素类管理API接口

要素类详情

要素类详情接口

path Parameters
projectId
required
integer <int64>

项目ID

featureId
required
integer <int64>

要素ID

Responses

更新要素类

更新要素类接口

path Parameters
projectId
required
integer <int64>

项目ID

featureId
required
integer <int64>

要素ID

Request Body schema: application/json
required
id
integer <int64>

要素类ID

name
string

要素类名称

alias
string

要素类别名

object

要素类配置

Responses

Request samples

Content type
application/json
{
  • "id": 15565656,
  • "name": "BHXCZTGH_KFBJ",
  • "alias": "BHXCZTGH_KFBJ",
  • "config": {
    }
}

要素类原始数据列表-数据批量更新

要素类原始数据列表-数据批量更新

path Parameters
projectId
required
integer <int64>

项目ID

query Parameters
featureId
required
integer <int64>

要素类ID

Request Body schema: application/json
required
Array
property name*
additional property
object

Responses

Request samples

Content type
application/json
[
  • {
    }
]

要素类原始数据列表-数据批量更新

要素类原始数据列表-数据批量更新

path Parameters
projectId
required
integer <int64>

项目ID

featureClassId
required
integer <int64>

要素类ID

Responses

要素类原始数据列表-数据批量删除

要素类原始数据列表-数据批量删除

path Parameters
projectId
required
integer <int64>

项目ID

featureClassId
required
any

要素类id

query Parameters
featureId
required
integer <int64>

要素类id

Request Body schema: application/json
required
Array
integer <int64>

Responses

Request samples

Content type
application/json
[
  • 0
]

shp文件入库接口

shp文件入库接口-目前只支持新增入库和增量入库

path Parameters
projectId
required
integer <int64>

项目ID

Request Body schema: application/json
required
123123123123
required
string non-empty

文件id

datasetId
required
integer <int64> >= 1

数据集ID, 应该是项目上指定的集合id

featureName
required
string non-empty

要素类名称, 不可为空

featureAlias
string

要素类别名

type
required
string

新建入库: new、增量入库: incremental

callBackUrl
string

入库成功后的回调地址, 会将数据post到指定地址

featureId
integer <int64>

要素类ID, 增量入库时传入 ,传入该字段,要素类名称和alias都不能传入

Responses

Request samples

Content type
application/json
{}

要素类基本信息分页列表

要素类基本信息分页列表查询接口

path Parameters
projectId
required
integer <int64>

项目ID

query Parameters
featureSetId
integer <int64>

要素集ID

featureType
integer <int32>

要素类型

containsAlias
boolean
Default: false

查询类型是否包含名称和别名,如果为true名称和别名任意一个匹配就会有结果,默认为false

name
string

要素类名称或者别名(包含)

publishStatus
integer <int32>

发布状态

pageIndex
integer <int32>
Default: 1

页码

pageSize
integer <int32>
Default: 10

每页数量

maxSize
integer <int64>

最大要素个数过滤

header Parameters
x-tenant-id
required
integer <int64>
x-user-id
required
string

Responses

要素类查询-通过源文件id查询

要素类查询-通过源文件id查询接口

path Parameters
projectId
required
integer <int64>

项目ID

query Parameters
fileId
required
integer <int64>

文件id

Responses

通过一个serviceId查询对应的要素类信息

通过一个serviceId查询对应的要素类信息接口[可视化有用到]

path Parameters
projectId
required
integer <int64>

项目ID

query Parameters
serviceId
required
integer <int64>

服务Id

Responses

通过一个fileVersionId查询对应的要素类信息

通过一个fileVersionId查询对应的要素类信息接口

path Parameters
projectId
required
integer <int64>

项目ID

query Parameters
fileVersionId
required
integer <int64>

文件ID

Responses

通过一个fileVersionId查询对应的要素类信息(源文件-要素类 一对多)

通过一个fileVersionId查询对应的要素类信息接口

path Parameters
projectId
required
integer <int64>

项目ID

query Parameters
fileVersionId
required
integer <int64>

文件ID

Responses

[openapi]-data-service-数据服务接口

停止数据服务

停止数据服务接口

path Parameters
projectId
required
integer <int64>
categoryId
required
integer <int64>
id
required
integer <int64>

id

Responses

启动数据服务

启动数据服务接口

path Parameters
projectId
required
integer <int64>
categoryId
required
integer <int64>
id
required
integer <int64>

id

Responses

注册类服务(第三方服务)编辑

注册类服务(第三方服务)编辑接口

path Parameters
projectId
required
integer <int64>
categoryId
required
integer <int64>
id
required
integer <int64>
Request Body schema: application/json
required
projectId
integer <int64>

所属项目id

name
string

服务名称

tpServiceSource
integer <int32>

第三方服务来源

serviceType
integer <int32>

第三方服务类型

serviceUrl
string

服务URL

tpServiceToken
string

服务token

tpServiceTokenPosition
string

服务鉴权方式

oldDirIds
string

专题id-目录id,英文逗号隔开

dirIds
string

所属目录id,英文逗号隔开

serviceTags
Array of strings

标签,json数组格式

description
string

服务描述

layer
string

第三方服务注册-图层名称(WMTS请求的图层名,注意区分:和服务名没关系,服务名是具有实际业务含义)

style
string

第三方服务注册-图层样式 默认:default

tilingScheme
string

第三方服务注册-切片方案(默认为地理切片方案 Geographic )

format
string

第三方服务注册-WMTS/WMS:切片格式(切片的格式,如:image/png、tiles);当imageryType=WMS,默认:image/png

object (Rectangle)

第三方服务注册-四至范围请求实体

minimumLevel
integer <int32>

第三方服务注册/本地服务-最小缩放层级

maximumLevel
integer <int32>

第三方服务注册/本地服务-最大缩放层级

tkName
string

第三方服务注册-token名称

tileMatrixLabels
string

第三方服务注册-WMTS请求的切片层级(["1","2","3"])

subdomains
string

第三方服务注册-子域名(负载均衡时使用,示例:["t1","t2","t3"])

layers
string

第三方服务注册-WMS请求的图层组

transparent
boolean

第三方服务注册-WMS:是否透明、默认true、布尔;默认:true

origin
Array of numbers <double> [ items <double > ]

第三方服务3dtiles-中心坐标:模型当前中心坐标,经度、维度、高度 [lat,lon,height],经纬度数值保留6位小数,高度保留2位小数

offset
Array of numbers <double> [ items <double > ]

第三方服务3dtiles-偏移值:[X,Y,Z],保留3位小数

rotation
Array of numbers <double> [ items <double > ]

第三方服务3dtiles-旋转值:[X,Y,Z],保留3位小数

scale
number <float>

第三方服务3dtiles-缩放比例:默认:1

object (TileInfo)

切片信息

coordSystem
string

本地服务-坐标系:默认值:CGCS2000

tileMatrixSetID
string

第三方服务注册-切片矩阵集标识符

Responses

Request samples

Content type
application/json
{
  • "projectId": 123,
  • "name": "wms服务",
  • "tpServiceSource": 1,
  • "serviceType": 1,
  • "serviceUrl": "http://geoserver.com/sa",
  • "tpServiceToken": "960400064",
  • "tpServiceTokenPosition": "header",
  • "oldDirIds": "3-1,2-3",
  • "dirIds": "1-1,2-5,3-6",
  • "serviceTags": [
    ],
  • "description": "Archgis服务",
  • "layer": "道路红线",
  • "style": "default",
  • "tilingScheme": "Geographic",
  • "format": "image/png",
  • "rectangle": {
    },
  • "minimumLevel": 1,
  • "maximumLevel": 18,
  • "tkName": "token",
  • "tileMatrixLabels": "[\"1\",\"2\",\"3\"]",
  • "subdomains": "[\"t1\",\"t2\",\"t3\"]",
  • "layers": "cva,cvb",
  • "transparent": true,
  • "origin": 18,
  • "offset": 18,
  • "rotation": 18,
  • "scale": 18,
  • "tileInfo": {
    },
  • "coordSystem": "18",
  • "tileMatrixSetID": "切片矩阵集标识符"
}

发布类服务(本地服务)编辑

发布类服务(本地服务)编辑接口

path Parameters
projectId
required
integer <int64>
categoryId
required
integer <int64>
id
required
integer <int64>
Request Body schema: application/json
required
id
integer <int64>

服务ID

databagId
string

minio:dir path and translate record databagId

projectId
required
integer <int64>

所属项目id

name
string

服务名称

serviceType
required
integer <int32>

服务类型

fileId
integer <int64>

模型文件id:发布转换类型的服务时,该字段必填, 注意使用file.fileVersionId

featureId
integer <int64>

要素类ID:如果是矢量数据,该字段为必填字段

epsg
string

空间参考值

pgTableName
string

矢量表名:如果是发布shp数据服务此字段必须传

shpTableAlias
string

矢量表别名

lcStyleId
integer <int64>

样式id:矢量类型的服务支持设置样式,矢量转换的白模类型也支持设置样式(新增需求)、点云也支持样式设置

oldDirIds
string

专题id-目录id,英文逗号隔开

dirIds
string

专题id-目录id,英文逗号隔开

serviceTags
Array of strings

标签,json数组格式

description
string

服务描述

serviceUrl
string

服务地址

dataType
integer <int32>

数据类型:1 正射影像图; 2 数字高程模型;3 倾斜摄影数据;4 矢量数据;5 精细模型数据;6 BIM模型数据;7 点云数据;8 其他数据;

object (Rectangle)

第三方服务注册-四至范围请求实体

minimumLevel
integer <int32>

第三方服务注册/本地服务-最小缩放层级

maximumLevel
integer <int32>

第三方服务注册/本地服务-最大缩放层级

coordSystem
string

本地服务-坐标系:默认值:CGCS2000

format
string

本地服务-格式:数据源为倾斜、BIM、精细模型为:b3dm 当数据源为点云:pnts

origin
Array of numbers <double> [ items <double > ]

本地服务-中心坐标:模型当前中心坐标,经度、维度、高度 [lat,lon,height],经纬度数值保留6位小数,高度保留2位小数

offset
Array of numbers <double> [ items <double > ]

本地服务-偏移值:[X,Y,Z],保留3位小数

rotation
Array of numbers <double> [ items <double > ]

本地服务-旋转值:[X,Y,Z],保留3位小数

scale
number <float>

本地服务-缩放比例:默认:1

transform
Array of numbers <double> [ items <double > ]

新的旋转矩阵, 如果有修改中心坐标|偏移|旋转|缩放, 则传入新的transform值, 16位数组

object (Label)

注记(注记默认字体风格font family:宋体)

object (VisualEffect)

可视化特效(只针对本地服务发布的矢量白模数据)

object (TileInfo)

切片信息

object (DistanceDisplay)

按视距显示图层

whiteModel
boolean

是否是白模

subServiceIds
Array of integers <int64> [ items <int64 > ]

3dtiles服务数据集合[数组]

transId
integer <int64>
modelIntegrateResultFileVersionId
string

模型集成服务替换的数据源

initCache
boolean

是否初始化缓存-mvt专属

hasElevation
boolean

是否支持三维地形表达

tileCached
boolean

是否开启wms切片缓存

tileFormats
Array of strings

是否开启wms切片缓存

tileSchemeId
integer <int64>

切片方案id

object (UVMap)

uv纹理贴图效果(只针对矢量白模数据,该参数和dynamic、Style互斥)

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "databagId": "string",
  • "projectId": 123,
  • "name": "wms服务",
  • "serviceType": 1,
  • "fileId": 123,
  • "featureId": 12,
  • "epsg": "EPSG:3857",
  • "pgTableName": "pg_gyd",
  • "shpTableAlias": "河流",
  • "lcStyleId": 123,
  • "oldDirIds": "3-1,2-3",
  • "dirIds": "3-1,2-3,4-7",
  • "serviceTags": [
    ],
  • "description": "abc",
  • "dataType": 1,
  • "rectangle": {
    },
  • "minimumLevel": 1,
  • "maximumLevel": 18,
  • "coordSystem": "18",
  • "format": "18",
  • "origin": 18,
  • "offset": 18,
  • "rotation": 18,
  • "scale": 18,
  • "transform": [
    ],
  • "label": {
    },
  • "visualEffect": {
    },
  • "tileInfo": {
    },
  • "distanceDisplay": {
    },
  • "whiteModel": true,
  • "subServiceIds": [
    ],
  • "transId": 0,
  • "modelIntegrateResultFileVersionId": "123123",
  • "initCache": true,
  • "hasElevation": true,
  • "tileCached": true,
  • "tileFormats": [
    ],
  • "tileSchemeId": 0,
  • "UVMap": {
    }
}

更新本地服务的要素类

更新本地服务的要素类(必须是同一文件不同的版本文件入库的要素类)

path Parameters
projectId
required
integer <int64>

项目ID

categoryId
required
integer <int64>

专题分类ID

id
required
integer <int64>

服务ID

Request Body schema: application/json
required
featureClassId
required
integer <int64>

要素类id

Responses

Request samples

Content type
application/json
{
  • "featureClassId": 2197945560260649
}

发布类服务(本地服务)编辑

发布类服务(本地服务)编辑接口

path Parameters
projectId
required
integer <int64>
categoryId
required
integer <int64>
id
required
integer <int64>
Request Body schema: application/json
required
id
integer <int64>

服务ID

databagId
string

minio:dir path and translate record databagId

projectId
required
integer <int64>

所属项目id

name
string

服务名称

serviceType
required
integer <int32>

服务类型

fileId
integer <int64>

模型文件id:发布转换类型的服务时,该字段必填, 注意使用file.fileVersionId

featureId
integer <int64>

要素类ID:如果是矢量数据,该字段为必填字段

epsg
string

空间参考值

pgTableName
string

矢量表名:如果是发布shp数据服务此字段必须传

shpTableAlias
string

矢量表别名

lcStyleId
integer <int64>

样式id:矢量类型的服务支持设置样式,矢量转换的白模类型也支持设置样式(新增需求)、点云也支持样式设置

oldDirIds
string

专题id-目录id,英文逗号隔开

dirIds
string

专题id-目录id,英文逗号隔开

serviceTags
Array of strings

标签,json数组格式

description
string

服务描述

serviceUrl
string

服务地址

dataType
integer <int32>

数据类型:1 正射影像图; 2 数字高程模型;3 倾斜摄影数据;4 矢量数据;5 精细模型数据;6 BIM模型数据;7 点云数据;8 其他数据;

object (Rectangle)

第三方服务注册-四至范围请求实体

minimumLevel
integer <int32>

第三方服务注册/本地服务-最小缩放层级

maximumLevel
integer <int32>

第三方服务注册/本地服务-最大缩放层级

coordSystem
string

本地服务-坐标系:默认值:CGCS2000

format
string

本地服务-格式:数据源为倾斜、BIM、精细模型为:b3dm 当数据源为点云:pnts

origin
Array of numbers <double> [ items <double > ]

本地服务-中心坐标:模型当前中心坐标,经度、维度、高度 [lat,lon,height],经纬度数值保留6位小数,高度保留2位小数

offset
Array of numbers <double> [ items <double > ]

本地服务-偏移值:[X,Y,Z],保留3位小数

rotation
Array of numbers <double> [ items <double > ]

本地服务-旋转值:[X,Y,Z],保留3位小数

scale
number <float>

本地服务-缩放比例:默认:1

transform
Array of numbers <double> [ items <double > ]

新的旋转矩阵, 如果有修改中心坐标|偏移|旋转|缩放, 则传入新的transform值, 16位数组

object (Label)

注记(注记默认字体风格font family:宋体)

object (VisualEffect)

可视化特效(只针对本地服务发布的矢量白模数据)

object (TileInfo)

切片信息

object (DistanceDisplay)

按视距显示图层

whiteModel
boolean

是否是白模

subServiceIds
Array of integers <int64> [ items <int64 > ]

3dtiles服务数据集合[数组]

transId
integer <int64>
modelIntegrateResultFileVersionId
string

模型集成服务替换的数据源

initCache
boolean

是否初始化缓存-mvt专属

hasElevation
boolean

是否支持三维地形表达

tileCached
boolean

是否开启wms切片缓存

tileFormats
Array of strings

是否开启wms切片缓存

tileSchemeId
integer <int64>

切片方案id

object (UVMap)

uv纹理贴图效果(只针对矢量白模数据,该参数和dynamic、Style互斥)

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "databagId": "string",
  • "projectId": 123,
  • "name": "wms服务",
  • "serviceType": 1,
  • "fileId": 123,
  • "featureId": 12,
  • "epsg": "EPSG:3857",
  • "pgTableName": "pg_gyd",
  • "shpTableAlias": "河流",
  • "lcStyleId": 123,
  • "oldDirIds": "3-1,2-3",
  • "dirIds": "3-1,2-3,4-7",
  • "serviceTags": [
    ],
  • "description": "abc",
  • "dataType": 1,
  • "rectangle": {
    },
  • "minimumLevel": 1,
  • "maximumLevel": 18,
  • "coordSystem": "18",
  • "format": "18",
  • "origin": 18,
  • "offset": 18,
  • "rotation": 18,
  • "scale": 18,
  • "transform": [
    ],
  • "label": {
    },
  • "visualEffect": {
    },
  • "tileInfo": {
    },
  • "distanceDisplay": {
    },
  • "whiteModel": true,
  • "subServiceIds": [
    ],
  • "transId": 0,
  • "modelIntegrateResultFileVersionId": "123123",
  • "initCache": true,
  • "hasElevation": true,
  • "tileCached": true,
  • "tileFormats": [
    ],
  • "tileSchemeId": 0,
  • "UVMap": {
    }
}

根据源数据id列表查询服务

根据源数据id列表查询服务

path Parameters
projectId
required
integer <int64>
Request Body schema: application/json
required
Array
integer <int64>

Responses

Request samples

Content type
application/json
[
  • 0
]

根据源数据id列表查询服务

根据源数据id列表查询服务

path Parameters
projectId
required
integer <int64>
Request Body schema: application/json
required
Array
integer <int64>

Responses

Request samples

Content type
application/json
[
  • 0
]

搜索数据服务-分页模式

搜索数据服务接口

path Parameters
projectId
required
integer <int64>
categoryId
required
integer <int64>
Request Body schema: application/json
required
pageIndex
integer <int32>

分页页码,默认1

pageSize
integer <int32>

每页数据数,默认10

name
string

服务名称或者ID

tpServiceSource
integer <int32>

服务来源

serviceType
integer <int32>

服务类型

serviceStatus
integer <int32>

服务状态

dateStart
string

发布日期-开始

dateEnd
string

发布日期-结束

projectId
integer <int64>

所属项目id

dirId
integer <int64>

当前目录id

onOffStatus
integer <int32>

上下架状态, 1上架 2下架

authorized
boolean

公开:false,私有:true

includeSub
boolean

是否包含下级服务

isCreate
boolean

是否创建时间降序

isDesc
boolean

是否降序

crs
string

坐标系

Responses

Request samples

Content type
application/json
{
  • "pageIndex": 1,
  • "pageSize": 10,
  • "name": "abc",
  • "tpServiceSource": 1,
  • "serviceType": 1,
  • "serviceStatus": 1,
  • "dateStart": "2021-01-14",
  • "dateEnd": "2021-01-14",
  • "projectId": 123,
  • "dirId": 123,
  • "onOffStatus": 1,
  • "authorized": false,
  • "includeSub": true,
  • "isCreate": true,
  • "isDesc": true,
  • "crs": "EPSG:4326"
}

注册第三方数据服务

注册新的第三方数据服务接口

path Parameters
projectId
required
integer <int64>
categoryId
required
integer <int64>
Request Body schema: application/json
required
projectId
integer <int64>

所属项目id

name
string

服务名称

tpServiceSource
integer <int32>

第三方服务来源

serviceType
integer <int32>

第三方服务类型

serviceUrl
string

服务URL

tpServiceToken
string

服务token

tpServiceTokenPosition
string

服务鉴权方式

oldDirIds
string

专题id-目录id,英文逗号隔开

dirIds
string

所属目录id,英文逗号隔开

serviceTags
Array of strings

标签,json数组格式

description
string

服务描述

layer
string

第三方服务注册-图层名称(WMTS请求的图层名,注意区分:和服务名没关系,服务名是具有实际业务含义)

style
string

第三方服务注册-图层样式 默认:default

tilingScheme
string

第三方服务注册-切片方案(默认为地理切片方案 Geographic )

format
string

第三方服务注册-WMTS/WMS:切片格式(切片的格式,如:image/png、tiles);当imageryType=WMS,默认:image/png

object (Rectangle)

第三方服务注册-四至范围请求实体

minimumLevel
integer <int32>

第三方服务注册/本地服务-最小缩放层级

maximumLevel
integer <int32>

第三方服务注册/本地服务-最大缩放层级

tkName
string

第三方服务注册-token名称

tileMatrixLabels
string

第三方服务注册-WMTS请求的切片层级(["1","2","3"])

subdomains
string

第三方服务注册-子域名(负载均衡时使用,示例:["t1","t2","t3"])

layers
string

第三方服务注册-WMS请求的图层组

transparent
boolean

第三方服务注册-WMS:是否透明、默认true、布尔;默认:true

origin
Array of numbers <double> [ items <double > ]

第三方服务3dtiles-中心坐标:模型当前中心坐标,经度、维度、高度 [lat,lon,height],经纬度数值保留6位小数,高度保留2位小数

offset
Array of numbers <double> [ items <double > ]

第三方服务3dtiles-偏移值:[X,Y,Z],保留3位小数

rotation
Array of numbers <double> [ items <double > ]

第三方服务3dtiles-旋转值:[X,Y,Z],保留3位小数

scale
number <float>

第三方服务3dtiles-缩放比例:默认:1

object (TileInfo)

切片信息

coordSystem
string

本地服务-坐标系:默认值:CGCS2000

tileMatrixSetID
string

第三方服务注册-切片矩阵集标识符

Responses

Request samples

Content type
application/json
{
  • "projectId": 123,
  • "name": "wms服务",
  • "tpServiceSource": 1,
  • "serviceType": 1,
  • "serviceUrl": "http://geoserver.com/sa",
  • "tpServiceToken": "960400064",
  • "tpServiceTokenPosition": "header",
  • "oldDirIds": "3-1,2-3",
  • "dirIds": "1-1,2-5,3-6",
  • "serviceTags": [
    ],
  • "description": "Archgis服务",
  • "layer": "道路红线",
  • "style": "default",
  • "tilingScheme": "Geographic",
  • "format": "image/png",
  • "rectangle": {
    },
  • "minimumLevel": 1,
  • "maximumLevel": 18,
  • "tkName": "token",
  • "tileMatrixLabels": "[\"1\",\"2\",\"3\"]",
  • "subdomains": "[\"t1\",\"t2\",\"t3\"]",
  • "layers": "cva,cvb",
  • "transparent": true,
  • "origin": 18,
  • "offset": 18,
  • "rotation": 18,
  • "scale": 18,
  • "tileInfo": {
    },
  • "coordSystem": "18",
  • "tileMatrixSetID": "切片矩阵集标识符"
}

模型集成上传成功数据

模型集成上传成功数据

path Parameters
projectId
required
integer <int64>
categoryId
required
integer <int64>
id
required
integer <int64>
Request Body schema: application/json
file
required
string <binary>

Responses

Request samples

Content type
application/json
{
  • "file": "string"
}

模型集成服务发布

发布新的模型集成服务

path Parameters
projectId
required
integer <int64>
categoryId
required
integer <int64>
Request Body schema: application/json
required
projectId
required
integer <int64>

所属项目id

name
required
string

服务名称

longitude
number
Deprecated

经度

latitude
number
Deprecated

纬度

height
number
Deprecated

高度

fileIds
required
Array of integers <int64> [ items <int64 > ]

BIM模型文件id集合[数组], 注意是fileVersionId

dirIds
required
string

专题id-目录id,英文逗号隔开

serviceTags
Array of strings

标签,json数组格式

description
string

服务描述

object

完整的配置信息

object

文本框输入的配置信息

topRebuild
boolean

是否性能优化

Responses

Request samples

Content type
application/json
{
  • "projectId": 123,
  • "name": "模型集成服务",
  • "longitude": 118.111211,
  • "latitude": 35.111211,
  • "height": 10001.111211,
  • "fileIds": [
    ],
  • "dirIds": "3-1,2-3,4-7",
  • "serviceTags": [
    ],
  • "description": "abc",
  • "config": {
    },
  • "originTranslateConfig": {
    },
  • "topRebuild": true
}

发布数据服务

发布新的本地服务接口

path Parameters
projectId
required
integer <int64>

项目ID

categoryId
required
integer <int64>

分类ID

Request Body schema: application/json
required
id
integer <int64>

服务ID

databagId
string

minio:dir path and translate record databagId

projectId
required
integer <int64>

所属项目id

name
string

服务名称

serviceType
required
integer <int32>

服务类型

fileId
integer <int64>

模型文件id:发布转换类型的服务时,该字段必填, 注意使用file.fileVersionId

featureId
integer <int64>

要素类ID:如果是矢量数据,该字段为必填字段

epsg
string

空间参考值

pgTableName
string

矢量表名:如果是发布shp数据服务此字段必须传

shpTableAlias
string

矢量表别名

lcStyleId
integer <int64>

样式id:矢量类型的服务支持设置样式,矢量转换的白模类型也支持设置样式(新增需求)、点云也支持样式设置

oldDirIds
string

专题id-目录id,英文逗号隔开

dirIds
string

专题id-目录id,英文逗号隔开

serviceTags
Array of strings

标签,json数组格式

description
string

服务描述

serviceUrl
string

服务地址

dataType
integer <int32>

数据类型:1 正射影像图; 2 数字高程模型;3 倾斜摄影数据;4 矢量数据;5 精细模型数据;6 BIM模型数据;7 点云数据;8 其他数据;

object (Rectangle)

第三方服务注册-四至范围请求实体

minimumLevel
integer <int32>

第三方服务注册/本地服务-最小缩放层级

maximumLevel
integer <int32>

第三方服务注册/本地服务-最大缩放层级

coordSystem
string

本地服务-坐标系:默认值:CGCS2000

format
string

本地服务-格式:数据源为倾斜、BIM、精细模型为:b3dm 当数据源为点云:pnts

origin
Array of numbers <double> [ items <double > ]

本地服务-中心坐标:模型当前中心坐标,经度、维度、高度 [lat,lon,height],经纬度数值保留6位小数,高度保留2位小数

offset
Array of numbers <double> [ items <double > ]

本地服务-偏移值:[X,Y,Z],保留3位小数

rotation
Array of numbers <double> [ items <double > ]

本地服务-旋转值:[X,Y,Z],保留3位小数

scale
number <float>

本地服务-缩放比例:默认:1

transform
Array of numbers <double> [ items <double > ]

新的旋转矩阵, 如果有修改中心坐标|偏移|旋转|缩放, 则传入新的transform值, 16位数组

object (Label)

注记(注记默认字体风格font family:宋体)

object (VisualEffect)

可视化特效(只针对本地服务发布的矢量白模数据)

object (TileInfo)

切片信息

object (DistanceDisplay)

按视距显示图层

whiteModel
boolean

是否是白模

subServiceIds
Array of integers <int64> [ items <int64 > ]

3dtiles服务数据集合[数组]

transId
integer <int64>
modelIntegrateResultFileVersionId
string

模型集成服务替换的数据源

initCache
boolean

是否初始化缓存-mvt专属

hasElevation
boolean

是否支持三维地形表达

tileCached
boolean

是否开启wms切片缓存

tileFormats
Array of strings

是否开启wms切片缓存

tileSchemeId
integer <int64>

切片方案id

object (UVMap)

uv纹理贴图效果(只针对矢量白模数据,该参数和dynamic、Style互斥)

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "databagId": "string",
  • "projectId": 123,
  • "name": "wms服务",
  • "serviceType": 1,
  • "fileId": 123,
  • "featureId": 12,
  • "epsg": "EPSG:3857",
  • "pgTableName": "pg_gyd",
  • "shpTableAlias": "河流",
  • "lcStyleId": 123,
  • "oldDirIds": "3-1,2-3",
  • "dirIds": "3-1,2-3,4-7",
  • "serviceTags": [
    ],
  • "description": "abc",
  • "dataType": 1,
  • "rectangle": {
    },
  • "minimumLevel": 1,
  • "maximumLevel": 18,
  • "coordSystem": "18",
  • "format": "18",
  • "origin": 18,
  • "offset": 18,
  • "rotation": 18,
  • "scale": 18,
  • "transform": [
    ],
  • "label": {
    },
  • "visualEffect": {
    },
  • "tileInfo": {
    },
  • "distanceDisplay": {
    },
  • "whiteModel": true,
  • "subServiceIds": [
    ],
  • "transId": 0,
  • "modelIntegrateResultFileVersionId": "123123",
  • "initCache": true,
  • "hasElevation": true,
  • "tileCached": true,
  • "tileFormats": [
    ],
  • "tileSchemeId": 0,
  • "UVMap": {
    }
}

批量启动/停止数据服务

批量启动/停止数据服务接口

path Parameters
projectId
required
integer <int64>
categoryId
required
integer <int64>
Request Body schema: application/json
required
start
boolean

是否启动

serviceIds
Array of integers <int64> [ items <int64 > ]

服务id列表

Responses

Request samples

Content type
application/json
{
  • "start": true,
  • "serviceIds": [
    ]
}

数据服务详情

数据服务详情接口

path Parameters
projectId
required
integer <int64>

项目ID

id
required
integer <int64>

id

Responses

判断是否是Sdb

判断是否是Sdb接口

path Parameters
projectId
required
integer <int64>

项目Id

query Parameters
serviceIds
required
Array of integers <int64> [ items <int64 > ]

图层id,可重复传参如 serviceIds=1&serviceIds=2

Responses

判断是否是fdb

判断是否是fdb接口

path Parameters
projectId
required
integer <int64>

项目Id

query Parameters
serviceIds
required
Array of integers <int64> [ items <int64 > ]

图层id,可重复传参如 serviceIds=1&serviceIds=2

Responses

服务的CRS集合

服务的CRS集合接口

path Parameters
projectId
required
integer <int64>

项目ID

query Parameters
categoryId
integer <int64>

专题ID

dirId
integer <int64>

目录ID

Responses

数据服务详情

数据服务详情接口

path Parameters
projectId
required
integer <int64>
categoryId
required
integer <int64>
id
required
integer <int64>

id

Responses

删除数据服务

删除数据服务接口

path Parameters
id
required
integer <int64>

id

projectId
required
integer <int64>

项目ID

categoryId
required
integer <int64>
query Parameters
deleteDirectly
boolean
Default: false

是否直接删除

Responses

批量删除数据服务

批量删除数据服务接口

path Parameters
projectId
required
integer <int64>
categoryId
required
integer <int64>
query Parameters
ids
required
string

要删除的服务id列表,英文逗号分隔

deleteDirectly
boolean
Default: false

Responses

[openapiV3]-bim模型数据信息接口

根据指定key in [value, value2]获取构件基础信息

获取构件信息集合接口

path Parameters
projectId
required
integer <int64>
serviceId
required
integer <int64>

服务id

query Parameters
viewToken
any
Example: viewToken=5cc338d9ad5e459e85129d816224f898

token

Request Body schema: application/json
required
key
required
string non-empty
values
required
Array of strings non-empty

Responses

Request samples

Content type
application/json
{
  • "key": "string",
  • "values": [
    ]
}

根据指定key in [value, value2]获取构件id

获取构件id集合接口

path Parameters
projectId
required
integer <int64>
serviceId
required
integer <int64>

服务id

query Parameters
viewToken
any
Example: viewToken=5cc338d9ad5e459e85129d816224f898

token

Request Body schema: application/json
required
key
required
string non-empty
values
required
Array of strings non-empty

Responses

Request samples

Content type
application/json
{
  • "key": "string",
  • "values": [
    ]
}

获取构件树

获取构件树接口,note: 只支持单文件服务, 模型集成服务不支持

path Parameters
projectId
required
integer <int64>
Example: 11111

项目id

serviceId
required
integer <int64>
Example: 20002020222

服务id|图层id

query Parameters
treeType
required
string
Default: null
Enum: "1-按楼层" "2-按专业" "3-按类型" "4-按系统"
Example: treeType=1

构件树类型

Responses

获取通用构件树

获取通用构件树json接口

path Parameters
projectId
required
integer <int64>
Example: 11111

项目id

serviceId
required
integer <int64>
Example: 20002020222

服务id|图层id

Responses

获取所有房间列表

获取所有房间列表接口

path Parameters
projectId
required
integer <int64>
Example: 11111

项目id

serviceId
required
integer <int64>

服务id

Responses

获取房间属性信息接口

获取房间属性信息接口

path Parameters
projectId
required
integer <int64>
Example: 11111

项目id

serviceId
required
integer <int64>

服务id

roomId
required
string

房间id

Responses

批量获取房间属性信息接口

批量获取房间属性信息接口,单次最多50个,如果大于50个,则取前50个, 如果房间id不存在, 不会返回该房间

path Parameters
projectId
required
integer <int64>
Example: 11111

项目id

serviceId
required
integer <int64>

服务id

query Parameters
roomIds
required
string

房间id集合,用[,]分隔,最多50个,大于50个取前50个,如有重复自动去重

Responses

获取[投影面]楼层列表

仅仅[投影面]获取楼层列表,如果不含有或者不支持,则返回空数组

path Parameters
projectId
required
integer <int64>
Example: 11111

项目id

serviceId
required
integer <int64>

服务id

Responses

获取[投影面]楼层geojson

获取[投影面]楼层geojson,如果没数据会提示[暂无数据]

path Parameters
projectId
required
integer <int64>
Example: 11111

项目id

serviceId
required
integer <int64>

服务id

floorId
required
string

楼层id

Responses

获取[投影面]文件楼层列表

仅仅[投影面]获取楼层列表,增加fileName标识, 单文件服务是1个, 模型集成返回多个

path Parameters
projectId
required
integer <int64>
Example: 11111

项目id

serviceId
required
integer <int64>

服务id

Responses

获取[投影面]楼层geojson

获取[投影面]楼层geojson,如果没数据会提示[暂无数据], 支持模型集成的服务

path Parameters
projectId
required
integer <int64>
Example: 11111

项目id

serviceId
required
integer <int64>

服务id

fileVersionId
required
string

文件VersionId

floorId
required
string

楼层id

Responses

获取项目json

获取项目json接口

path Parameters
projectId
required
integer <int64>
Example: 11111

项目id

serviceId
required
integer <int64>

服务id

Responses

获取楼层列表

仅仅获取楼层列表

path Parameters
projectId
required
integer <int64>
Example: 11111

项目id

serviceId
required
integer <int64>

服务id

Responses

获取楼层下的房间列表

获取楼层下的房间列表接口

path Parameters
projectId
required
integer <int64>
Example: 11111

项目id

serviceId
required
integer <int64>

服务id

floorId
required
string

楼层id

Responses

获取楼层下的[area]列表

获取楼层下的[area]列表接口

path Parameters
projectId
required
integer <int64>
Example: 11111

项目id

serviceId
required
integer <int64>

服务id

floorId
required
string

楼层id

Responses

获取楼层列表

仅仅获取楼层列表,增加fileName标识, 单文件服务是1个, 模型集成返回多个

path Parameters
projectId
required
integer <int64>
Example: 11111

项目id

serviceId
required
integer <int64>

服务id

Responses

获取构件列表

tree的末级几点关联的构件列表获取接口, 不同的树类型要传入不同的id:

  1. 按楼层必须传入: floorId, cateogryId, familyId, familyTypeId
  2. 按专业必须传入: specialtyId, cateogryId, familyId, familyTypeId
  3. 按类型必须传入: cateogryId, familyId, familyTypeId
  4. 按系统必须传入: systemId, cateogryId, familyId, familyTypeId
path Parameters
projectId
required
integer <int64>
Example: 11111

项目id

serviceId
required
integer <int64>

服务id

query Parameters
treeType
required
string
Default: null
Enum: "1-按楼层" "2-按专业" "3-按类型" "4-按系统"
Example: treeType=1

构件树类型

floorId
string

楼层id

specialtyId
string

专业id

systemId
string

系统id

categoryId
string

类型id

familyId
string

构件类型(族类型)id

familyTypeId
string

构建类别(族类别)id

Responses

获取模型构件属性

获取模型构件属性接口, 支持bim文件转换后发布的3dtiles服务以及模型集成的3dtiles服务

path Parameters
projectId
required
integer <int64>

项目id

serviceId
required
integer <int64>

图层id,服务Id

elementId
required
string

构件ID

Responses

获取构件材质

获取构件材质接口

path Parameters
projectId
required
integer <int64>
serviceId
required
integer <int64>

服务id

elementId
required
string

构件ID

query Parameters
viewToken
any
Example: viewToken=5cc338d9ad5e459e85129d816224f898

token

Responses

通过指定的key=value,获取对应模型构件属性

获取模型构件属性接口, 支持bim文件转换后发布的3dtiles服务以及模型集成的3dtiles服务

path Parameters
projectId
required
integer <int64>

项目id

serviceId
required
integer <int64>

图层id,服务Id

query Parameters
key
required
string

属性key

val
required
string

属性value

Responses

获取构件id列表

用于查询任何节点所包含的所有构件id集合, 主要适用于构件集合的显隐:

  1. 按楼层必须传入: floorId,
  2. 按专业必须传入: specialtyId,
  3. 按类型必须传入: cateogryId,
  4. 按系统必须传入: systemId, 按层级传入, 例如: 楼层-[类型-构件类型-构件类别]
path Parameters
projectId
required
integer <int64>
Example: 11111

项目id

serviceId
required
integer <int64>

服务id

query Parameters
treeType
required
string
Default: null
Enum: "1-按楼层" "2-按专业" "3-按类型" "4-按系统"
Example: treeType=1

构件树类型

floorId
string

楼层id

specialtyId
string

专业id

systemId
string

系统id

categoryId
string

类型id

familyId
string

构件类型(族类型)id

familyTypeId
string

构建类别(族类别)id

Responses

获取drawing数据

会返回一个json字符串,需要自行格式化, 用于前端绘制图纸

path Parameters
projectId
required
integer <int64>
Example: 11111

项目id

serviceId
required
integer <int64>

服务id

Responses

服务构件定位偏移检查

服务构件定位偏移检查接口,部分服务的构件定位需要偏移旋转后才能到正确为止

path Parameters
projectId
required
integer <int64>
Example: 11111

项目id

serviceId
required
integer <int64>

服务id

Responses

获取bimface文件view token

获取bimface文件view token

path Parameters
projectId
required
integer <int64>
Example: 11111

项目id

serviceId
required
integer <int64>

服务id

Responses

获取bimface的modeldrive.db文件下载地址

获取bimface的modeldrive.db文件下载地址

path Parameters
projectId
required
integer <int64>
Example: 11111

项目id

serviceId
required
integer <int64>

服务id

Responses

获取所有area列表

获取所有area列表接口

path Parameters
projectId
required
integer <int64>
Example: 11111

项目id

serviceId
required
integer <int64>

服务id

Responses

获取Area详情接口

获取Area详情接口

path Parameters
projectId
required
integer <int64>
Example: 11111

项目id

serviceId
required
integer <int64>

服务id

areaId
required
string

areaId

Responses

获取areaId面的geojson字符串

获取areaId面的geojson字符串

path Parameters
projectId
required
integer <int64>
Example: 11111

项目id

serviceId
required
integer <int64>

服务id

areaId
required
string

areaId

Responses

获取所有area列表[json静态来源]

获取所有area列表接口

path Parameters
projectId
required
integer <int64>
Example: 11111

项目id

serviceId
required
integer <int64>

服务id

Responses

批量获取Area详情接口

批量获取Area详情接口,单次最多50个,如果大于50个,则取前50个, 如果areaId不存在, 不会返回该area

path Parameters
projectId
required
integer <int64>
Example: 11111

项目id

serviceId
required
integer <int64>

服务id

query Parameters
areaIds
required
string

房间id集合,用[,]分隔,最多50个,大于50个取前50个,如有重复自动去重

Responses

获取全部构件id列表

用于查询所有构件id集合, 主要适用于构件集合的显隐

path Parameters
projectId
required
integer <int64>
Example: 11111

项目id

serviceId
required
integer <int64>
Example: 20002020222

服务id|图层id

query Parameters
treeType
required
string
Default: null
Enum: "1-按楼层" "2-按专业" "3-按类型" "4-按系统"
Example: treeType=1

构件树类型

Responses

[openapiV3]-碰撞检测API接口

查询碰撞检测列表

path Parameters
projectId
required
integer <int64>

项目ID

query Parameters
status
string
Request Body schema: application/json
required
Array
integer <int64>

Responses

Request samples

Content type
application/json
[
  • 0
]

批量发起碰撞检测

path Parameters
projectId
required
integer <int64>

项目ID

Request Body schema: application/json
required
Array
index
required
integer <int32>

数据所在下标

required
object (ClashDetectiveSourceReq)

碰撞源请求体

required
object (ClashDetectiveSourceReq)

碰撞源请求体

required
object (ClashDetectiveConfigReq)

碰撞检测配置请求体

Responses

Request samples

Content type
application/json
[
  • {
    }
]

查询碰撞文件得构件定位纠偏信息

path Parameters
projectId
required
integer <int64>

项目ID

clashDetectiveId
required
integer <int64>

碰撞Id

fileVersionId
required
integer <int64>

文件版本Id

Responses

查询碰撞检测明细列表

path Parameters
projectId
required
integer <int64>

项目ID

clashDetectiveId
required
integer <int64>

碰撞检测id

query Parameters
elementName
required
string

构建名称

pageNo
required
integer <int32>

分页数

pageSize
required
integer <int32>

分页大小

Responses

[openapi]-data-service-数据服务接口v2

全量数据服务查询-分页模式

全量数据服务查询接口

Request Body schema: application/json
required
pageIndex
integer <int32>

分页页码,默认1

pageSize
integer <int32>

每页数据数,默认10

name
string

服务名称或者ID

tpServiceSource
integer <int32>

服务来源

serviceType
integer <int32>

服务类型

serviceStatus
integer <int32>

服务状态

dateStart
string

发布日期-开始

dateEnd
string

发布日期-结束

projectId
integer <int64>

所属项目id

dirId
integer <int64>

当前目录id

onOffStatus
integer <int32>

上下架状态, 1上架 2下架

authorized
boolean

公开:false,私有:true

includeSub
boolean

是否包含下级服务

isCreate
boolean

是否创建时间降序

isDesc
boolean

是否降序

crs
string

坐标系

Responses

Request samples

Content type
application/json
{
  • "pageIndex": 1,
  • "pageSize": 10,
  • "name": "abc",
  • "tpServiceSource": 1,
  • "serviceType": 1,
  • "serviceStatus": 1,
  • "dateStart": "2021-01-14",
  • "dateEnd": "2021-01-14",
  • "projectId": 123,
  • "dirId": 123,
  • "onOffStatus": 1,
  • "authorized": false,
  • "includeSub": true,
  • "isCreate": true,
  • "isDesc": true,
  • "crs": "EPSG:4326"
}

[openapi]-tools-工具相关的openapi接口

空间坐标转换

坐标转换接口

Request Body schema: application/json
required
sourceCRS
required
string non-empty

源坐标系

targetCRS
required
string non-empty

目标坐标系

coordinates
required
Array of numbers non-empty [ items ]

坐标点集合

Responses

Request samples

Content type
application/json
{
  • "sourceCRS": "string",
  • "targetCRS": "string",
  • "coordinates": [
    ]
}

空间坐标转换

坐标转换接口

query Parameters
url
required
string

Responses

[openapi]-src-bim-project-bim源数据工程项目接口

工程项目列表

工程项目列表查询接口

path Parameters
projectId
required
integer <int64>

项目Id

query Parameters
pageIndex
string
Default: null

页码

pageSize
string
Default: null

每页数量

Responses

创建工程项目

创建新的工程项目接口

path Parameters
projectId
required
integer <int64>

项目Id

Request Body schema: application/json
required
id
integer <int64>

id

projectId
integer <int64>

所属数管cim项目id

parentId
integer <int64>

bim数据目录在bdfs中的fileId

projectCode
string

工程项目统一代码

name
string

工程项目名称

projectTypeCode
string

工程项目类型编码

projectAddr
string

工程项目地址

Array of objects (SrcBimLabelDataReq)

标签值列表

Responses

Request samples

Content type
application/json
{
  • "id": 123,
  • "projectId": 123,
  • "parentId": 123,
  • "projectCode": "a1",
  • "name": "某项目",
  • "projectTypeCode": "a1",
  • "projectAddr": "a",
  • "labelDataList": [
    ]
}

删除工程项目

删除工程项目接口

path Parameters
projectId
required
integer <int64>

项目Id

Request Body schema: application/json
required
fileIds
string

fileIds拼接的字符串,英文逗号分隔,单个多个id都可以

Responses

Request samples

Content type
application/json
{
  • "fileIds": "1,2,3"
}

[openapi]-src-bim-unit-bim源数据工程单元接口

工程单元列表

工程单元列表查询接口

path Parameters
projectId
required
integer <int64>

cim项目Id

bpId
required
string

工程项目fileId

query Parameters
pageIndex
string
Default: null

页码

pageSize
string
Default: null

每页数量

Responses

创建工程单元

创建新的工程单元接口

path Parameters
projectId
required
integer <int64>

cim项目Id

bpId
required
string

工程项目fileId

Request Body schema: application/json
required
id
integer <int64>

id

projectId
integer <int64>

所属数管cim项目id

bimProjectId
integer <int64>

所属bim类源数据工程项目id

name
string

工程单元名称

unitCode
string

工程单元编码

unitStructTypeCode
string

工程单元结构类型编码

Array of objects (SrcBimLabelDataReq)

标签值列表

Responses

Request samples

Content type
application/json
{
  • "id": 123,
  • "projectId": 123,
  • "bimProjectId": 123,
  • "name": "某单元",
  • "unitCode": "a1",
  • "unitStructTypeCode": "a1",
  • "labelDataList": [
    ]
}

删除工程单元

删除工程单元接口

path Parameters
projectId
required
integer <int64>

cim项目Id

bpId
required
any

工程项目fileId

Request Body schema: application/json
required
fileIds
string

fileIds拼接的字符串,英文逗号分隔,单个多个id都可以

Responses

Request samples

Content type
application/json
{
  • "fileIds": "1,2,3"
}

[openapi]-layer-scene-consumable-服务->场景可消费图层API

通过服务ID获取图层属性

通过服务ID获取图层属性接口

path Parameters
projectId
required
integer <int64>

项目ID

Request Body schema: application/json
required
Array
integer <int64>

Responses

Request samples

Content type
application/json
[
  • 0
]

[openapi]-file-resource-资源管理相关接口

文件所有版本查看

文件所有版本

path Parameters
projectId
required
integer <int64>

项目ID

fileId
required
string
Example: 2229541555036320

主文件ID

query Parameters
translateStatus
string
Default: null
Enum: "success" "prepare" "processing" "failed"
Example: translateStatus=success

文件转换状态

serviceType
integer <int32>
Example: serviceType=1

服务类型

Responses

上传版本文件

上传版本文件

path Parameters
projectId
required
integer <int64>

项目ID

fileId
required
string
Example: 2229541555036320

主文件ID

query Parameters
name
required
string
Example: name=1212.fbx

文件名称

crs
string
Default: "EPSG:4490"
autoPublished
boolean
resultData
boolean
Default: false

是否成果数据,默认false

file
string <binary>

文件

Request Body schema: application/json
string <binary>

文件

Responses

Request samples

Content type
application/json
"string"

上传文件

上传文件接口

path Parameters
projectId
required
integer <int64>

项目ID

query Parameters
parentId
required
string
Example: parentId=2229541555036320

父文件夹ID

name
string
Example: name=2197945560260640

文件名称

crs
string
Default: "EPSG:4490"
Example: crs=EPSG:4490

坐标系

autoPublished
boolean

是否自动发布

resultData
boolean
Default: false

是否成果数据

hasMetaFile
boolean
Default: false

是否有元数据文件, 针对影像成果数据

serviceType
integer <int32>
Example: serviceType=12

切片类型, 针对影像成果数据(7-XYZ, 13-TMS)

bbox
string
Example: minX=1&minY=1&maxX=2&maxY=2

切片范围, json字符串, 针对影像成果数据

bbox
string <string>
Example: minX=1&minY=1&maxX=2&maxY=2

切片范围, json字符串, 针对影像成果数据

file
string <binary>

文件

Request Body schema: application/json
string <binary>

文件

Responses

Request samples

Content type
application/json
"string"

删除文件

删除文件接口

path Parameters
projectId
required
integer <int64>

项目ID

Request Body schema: application/json
required
fileIds
Array of strings

要删除的文件id集合

folderIds
Array of strings

要删除的文件夹id集合

Responses

Request samples

Content type
application/json
{
  • "fileIds": [
    ],
  • "folderIds": [
    ]
}

上传文件

上传文件接口

path Parameters
projectId
required
integer <int64>

项目ID

query Parameters
parentId
required
string
Example: parentId=2229541555036320

父文件夹ID

name
string
Example: name=2197945560260640

文件名称

crs
string
Default: "EPSG:4490"
Example: crs=EPSG:4490

坐标系

autoPublished
boolean

是否自动发布

resultData
boolean
Default: false

是否成果数据

hasMetaFile
boolean
Default: false

是否有元数据文件, 针对影像成果数据

serviceType
integer <int32>
Example: serviceType=12

切片类型, 针对影像成果数据(7-XYZ, 13-TMS)

bbox
string
Example: minX=1&minY=1&maxX=2&maxY=2

切片范围, json字符串, 针对影像成果数据

bbox
string <string>
Example: minX=1&minY=1&maxX=2&maxY=2

切片范围, json字符串, 针对影像成果数据

file
string <binary>

文件

Request Body schema: application/json
string <binary>

文件

Responses

Request samples

Content type
application/json
"string"

搜索资源

模糊搜索指定目录下的资源(包含子目录,只返回叶子结点)

path Parameters
projectId
required
integer <int64>

项目ID

Request Body schema: application/json
required
pageIndex
integer <int32>

分页页码,默认1

pageSize
integer <int32>

每页数据数,默认10

projectId
required
integer <int64>

所属项目id

folderFileId
string

所属文件夹Id, 可为空, 为空则搜索所有当前项目的数据

translateStatus
string

文件转换状态

dbStatus
string

矢量数据入库状态

name
string

文件名称

uploadTimeFrom
string <date-time>

上传时间时间戳(始, 13位, 带毫秒)

uploadTimeTo
string <date-time>

上传时间时间戳(终, 13位, 带毫秒)

publishStatus
integer <int32>

发布状态

checkVersionStatus
boolean

checkVersionStatus

serviceType
integer <int32>

服务类型

Responses

Request samples

Content type
application/json
{
  • "pageIndex": 1,
  • "pageSize": 10,
  • "projectId": 123,
  • "folderFileId": "123",
  • "translateStatus": "success",
  • "dbStatus": "success",
  • "name": "影像",
  • "uploadTimeFrom": "2019-08-24T14:15:22Z",
  • "uploadTimeTo": "2019-08-24T14:15:22Z",
  • "publishStatus": 1,
  • "checkVersionStatus": true,
  • "serviceType": 1
}

获取分片上传单片url

获取分片上传的指定片的put请求url

path Parameters
projectId
required
integer <int64>

项目ID

Request Body schema: application/json
required
id
string
partNum
integer <int32>
expiredTime
integer <int32>
type
string
Enum: "PRIVATE" "PUBLIC" "INTERNAL"

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "partNum": 0,
  • "expiredTime": 0,
  • "type": "PRIVATE"
}

创建分片上传文件

创建分片上传文件口,fileMerge模式

path Parameters
projectId
required
integer <int64>

项目ID

Request Body schema: application/json
required
parentId
string
parentPath
string
fileItemId
string
path
string
name
string
length
integer <int64>
sourceId
string

Responses

Request samples

Content type
application/json
{
  • "parentId": "string",
  • "parentPath": "string",
  • "fileItemId": "string",
  • "path": "string",
  • "name": "string",
  • "length": 0,
  • "sourceId": "string"
}

分片上传成功

分片上传成功请求

path Parameters
projectId
required
integer <int64>

项目ID

query Parameters
resultData
string
Default: null

是否是成果数据

crs
string
Default: "EPSG:4490"
autoPublished
boolean
resultDataAutoTranslate
boolean
Default: true
Request Body schema: application/json
required
id
string
parentId
string
parentPath
string
autoPublished
boolean
crs
string
hasMetaFile
boolean
resultData
boolean
serviceType
integer <int32>
bbox
string
resultDataAutoTranslate
boolean

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "parentId": "string",
  • "parentPath": "string",
  • "autoPublished": true,
  • "crs": "string",
  • "hasMetaFile": true,
  • "resultData": true,
  • "serviceType": 0,
  • "bbox": "string",
  • "resultDataAutoTranslate": true
}

取消已经创建的分片上传请求

中间取消上传,建议调用取消请求

path Parameters
projectId
required
integer <int64>

项目ID

Request Body schema: application/json
required
id
string
parentId
string
parentPath
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "parentId": "string",
  • "parentPath": "string"
}

上传文件前置校验接口

上传文件前置校验接口

path Parameters
projectId
required
integer <int64>

项目ID

query Parameters
parentId
required
string
Example: parentId=2229541555036320

父文件夹ID

name
required
string
Example: name=2197945560260640

文件名称

Responses

7大类对应的文件夹信息接口

7大类对应的文件夹信息接口-需要指定类别

path Parameters
projectId
required
integer <int64>

项目ID

query Parameters
dataTypes
required
string

数据类型, 多个直接用[,]分隔

Responses

文件夹下文件[基本信息]列表

查询文件夹下文件列表接口, 基本信息不包含文件夹路径, bim分析项, 空间编码等信息

path Parameters
projectId
required
integer <int64>

项目ID

fileId
required
string

文件夹ID

query Parameters
required
object (FileContentListReq)
translateStatus
string
Default: null
Enum: "success" "prepare" "processing" "failed"
Example: translateStatus=success

文件转换状态

serviceType
any
Example: serviceType=1

服务类型

name
any

文件名称(包含)

uploadTimeFrom
any

上传时间(开始)

uploadTimeTo
any

上传时间(结束)

checkVersionStatus
any

是否检测历史版本文件的转换状态.默认不检测,[只支持translateStatus=success并且指定服务类型的时候]如果检测的话, 如果历史版本有符合转换状态的信息,也会将当前最新版本文件返回

Responses

文件夹下文件[基本信息]列表(分页)

查询文件夹下文件列表接口, 基本信息不包含文件夹路径, bim分析项, 空间编码等信息

path Parameters
projectId
required
integer <int64>

项目ID

fileId
required
string

文件ID

query Parameters
required
object (FileContentListReq)
translateStatus
string
Default: null
Enum: "success" "prepare" "processing" "failed"
Example: translateStatus=success

文件转换状态

serviceType
any
Example: serviceType=1

服务类型

name
any

文件名称(包含)

uploadTimeFrom
any

上传时间(开始)

uploadTimeTo
any

上传时间(结束)

checkVersionStatus
any

是否检测历史版本文件的转换状态.默认不检测,如果检测的话, 如果历史版本有符合转换状态的信息,也会将当前最新版本文件返回

pageIndex
string
Default: null

页码

pageSize
string
Default: null

每页数量

Responses

文件夹下文件列表

查询文件夹下文件列表接口

path Parameters
projectId
required
integer <int64>

项目ID

fileId
required
string

文件夹ID

query Parameters
required
object (FileContentListReq)
translateStatus
string
Default: null
Enum: "success" "prepare" "processing" "failed"
Example: translateStatus=success

文件转换状态

serviceType
any
Example: serviceType=1

服务类型

name
any

文件名称(包含)

uploadTimeFrom
any

上传时间(开始)

uploadTimeTo
any

上传时间(结束)

checkVersionStatus
any

是否检测历史版本文件的转换状态.默认不检测,[只支持translateStatus=success并且指定服务类型的时候]如果检测的话, 如果历史版本有符合转换状态的信息,也会将当前最新版本文件返回

Responses

文件夹下文件列表(分页)

查询文件夹下文件列表接口

path Parameters
projectId
required
integer <int64>

项目ID

fileId
required
string

文件ID

query Parameters
required
object (FileContentListReq)
translateStatus
string
Default: null
Enum: "success" "prepare" "processing" "failed"
Example: translateStatus=success

文件转换状态

serviceType
any
Example: serviceType=1

服务类型

name
any

文件名称(包含)

uploadTimeFrom
any

上传时间(开始)

uploadTimeTo
any

上传时间(结束)

checkVersionStatus
any

是否检测历史版本文件的转换状态.默认不检测,如果检测的话, 如果历史版本有符合转换状态的信息,也会将当前最新版本文件返回

pageIndex
string
Default: null

页码

pageSize
string
Default: null

每页数量

Responses

下载文件 Deprecated

下载文件接口(废弃),建议使用获取下载链接接口, 然后下载的流程

path Parameters
projectId
required
integer <int64>

项目ID

fileVersionId
required
string

文件ID

query Parameters
fileName
required
string

文件名称

Responses

查询文件发布的服务(集合)

查询文件发布的服务(集合)

path Parameters
projectId
required
integer <int64>

项目ID

fileVersionId
required
integer <int64>

文件VersionID

Responses

获取文件详细信息

查询文件详细信息接口

path Parameters
projectId
required
integer <int64>

项目ID

fileVersionId
required
string

文件versionId

Responses

获取文件下载链接

获取文件下载链接接口(链接有效时长2H)

path Parameters
projectId
required
integer <int64>

项目ID

fileVersionId
required
string

文件ID

Responses

获取文件波段信息

获取文件波段信息接口

path Parameters
projectId
required
integer <int64>

项目ID

fileVersionId
required
integer <int64>

文件版本ID

Responses

判断是否是Sdb

判断是否是Sdb接口

path Parameters
projectId
required
integer <int64>

项目Id

query Parameters
fileVersionId
required
integer <int64>

文件版本id

Responses

判断是否是fdb

判断是否是fdb接口

path Parameters
projectId
required
integer <int64>

项目Id

query Parameters
fileVersionId
required
integer <int64>

文件版本id

Responses

查询要素类发布的服务(集合)

查询要素类发布的服务(集合)

path Parameters
projectId
required
integer <int64>

项目ID

featureClassId
required
integer <int64>

要素类ID

Responses

删除指定文件版本

删除文件版本,只是删除一个版本

path Parameters
projectId
required
integer <int64>

项目ID

fileId
required
string
Example: 2229541555036320

主文件ID

fileVersionId
required
string
Example: 2229541555036320

文件版本ID

Responses

删除文件

删除文件接口

path Parameters
projectId
required
integer <int64>

项目ID

Request Body schema: application/json
required
fileIds
Array of strings

要删除的文件id集合

folderIds
Array of strings

要删除的文件夹id集合

Responses

Request samples

Content type
application/json
{
  • "fileIds": [
    ],
  • "folderIds": [
    ]
}

[openapi]-feature-query-要素查询相关

要素查询

要素查询接口

path Parameters
projectId
required
integer <int64>

项目ID

Request Body schema: application/json
required
featureClassId
required
integer <int64>

要素类id

where
string

属性查询,条件语句

geometry
string

查询的几何,即:输入的空间查询范围(jsonString类型)

bufferDistance
number

缓冲区距离(点就是半径,线、面就是距离),默认为0,单位:米

bufferRule
string

缓冲区规则,指定缓冲区构造的形式,可参见:http://postgis.net/docs/ST_Buffer.html

spatialRelationShip
string

枚举,空间关系

outFields
Array of strings

要查询的字段, 为空则查询所有字段, 如果指定字段

orderBy
string

排序字段和方式, 例如 fid ASC

offset
integer <int32>

offset, 下标从0开始, 如果是0可不填

limit
integer <int32>

limit, 如果不填写(可为空)则是所有(慎用)

Responses

Request samples

Content type
application/json
{
  • "featureClassId": 0,
  • "where": "属性查询,条件语句[postgres语法],如:\"name\" = 'luo' and \"AGE\" >30 '",
  • "geometry": "string",
  • "bufferDistance": 1.2,
  • "bufferRule": "join=bevel",
  • "spatialRelationShip": "string",
  • "outFields": [
    ],
  • "orderBy": "id ASC",
  • "offset": 0,
  • "limit": 10
}

要素查询(分页)

分页要素查询接口

path Parameters
projectId
required
integer <int64>

项目ID

Request Body schema: application/json
required
pageIndex
integer <int32>

分页页码,默认1

pageSize
integer <int32>

每页数据数,默认10

featureClassId
required
integer <int64>

要素类id

where
string

属性查询,条件语句

geometry
string

查询的几何,即:输入的空间查询范围(jsonString类型)

bufferDistance
number

缓冲区距离(点就是半径,线、面就是距离),默认为0,单位:米

bufferRule
string

缓冲区规则,指定缓冲区构造的形式,可参见:http://postgis.net/docs/ST_Buffer.html

spatialRelationShip
string

枚举,空间关系

outFields
Array of strings

要查询的字段, 为空则查询所有字段

orderBy
string

排序字段和方式, 例如 fid ASC

Responses

Request samples

Content type
application/json
{
  • "pageIndex": 1,
  • "pageSize": 10,
  • "featureClassId": 0,
  • "where": "属性查询,条件语句[postgres语法],如:\"name\" = 'luo' and \"AGE\" >30 '",
  • "geometry": "string",
  • "bufferDistance": 1.2,
  • "bufferRule": "join=bevel",
  • "spatialRelationShip": "string",
  • "outFields": [
    ],
  • "orderBy": "id ASC"
}

[openapi]-drawing-query-图纸空间查询

图纸空间查询

支持通过指定范围区域,查询相应的图纸元素(点、线、面)

path Parameters
projectId
required
integer <int64>

项目ID

Request Body schema: application/json
required
serviceId
required
integer <int64>

服务ID

required
object non-empty

空间范围(geojson)

featureType
integer <int32>

要素类型(点、线、面)

Responses

Request samples

Content type
application/json
{
  • "serviceId": 0,
  • "geometry": {
    },
  • "featureType": 0
}

[openapi]-clash-detective-碰撞检测API接口

创建碰撞检测 Deprecated

path Parameters
projectId
required
integer <int64>

项目ID

Request Body schema: application/json
required
clashType
string
Enum: "Hard" "Clearance" "Duplicates"
tolerance
number <double>
object (ClashDetectiveSource)
object (ClashDetectiveSource)
callback
string
projectId
integer <int64>
object

Responses

Request samples

Content type
application/json
{
  • "clashType": "Hard",
  • "tolerance": 0.1,
  • "selectionA": {
    },
  • "selectionB": {
    },
  • "callback": "string",
  • "projectId": 0,
  • "config": {
    }
}

查询碰撞检测状态 Deprecated

path Parameters
projectId
required
integer <int64>

项目ID

clashDetectiveId
required
integer <int64>

碰撞检测id

Responses

查询碰撞检测结果 Deprecated

path Parameters
projectId
required
integer <int64>

项目ID

clashDetectiveId
required
integer <int64>

碰撞检测id

Responses

[openapi]-net-height-analysis-净高分析相关接口

查询净高分析列表

path Parameters
projectId
required
integer <int64>

项目ID

Request Body schema: application/json
required
fileVersionIds
required
Array of strings non-empty

文件ID集合

status
string

分析状态

Responses

Request samples

Content type
application/json
{
  • "fileVersionIds": [
    ],
  • "status": "string"
}

批量发起净高分析

批量发起净高分析

path Parameters
projectId
required
integer <int64>

项目ID

Request Body schema: application/json
required
Array
fileVersionId
required
string

文件ID

analysisConfigId
required
integer <int64>

分析配置ID

Responses

Request samples

Content type
application/json
[
  • {
    }
]

净高分析详情

path Parameters
projectId
required
integer <int64>

项目ID

id
required
integer <int64>

净高分析id

Responses

净高分析楼层列表

path Parameters
projectId
required
integer <int64>

项目ID

id
required
integer <int64>

净高分析id

Responses

净高分析空间数据列表

path Parameters
projectId
required
integer <int64>

项目ID

id
required
integer <int64>

净高分析id

query Parameters
name
string

空间名称

floorId
string

楼层id,可选

pageIndex
string
Default: null

页码

pageSize
string
Default: null

每页条数

Responses

查询指定空间的属性集合

path Parameters
projectId
required
integer <int64>

项目ID

id
required
integer <int64>

净高分析id

elementId
required
integer <int64>

空间id

Responses

[openapi]-explosion-record-爆炸分解相关API接口

更新楼层偏移值接口

目前只可以更新非0的偏移值

path Parameters
projectId
required
integer <int64>

项目ID

id
required
integer <int64>

爆炸分析记录id

resultId
required
integer <int64>

楼层偏移结果id

Request Body schema: application/json
required
offset
Array of numbers = 3 items

Responses

Request samples

Content type
application/json
{
  • "offset": [
    ]
}

查询爆炸分析列表

path Parameters
projectId
required
integer <int64>

项目ID

Request Body schema: application/json
required
fileVersionIds
required
Array of strings non-empty

文件ID集合

status
string

分析状态

Responses

Request samples

Content type
application/json
{
  • "fileVersionIds": [
    ],
  • "status": "string"
}

爆炸分析详情

path Parameters
projectId
required
integer <int64>

项目ID

id
required
integer <int64>

爆炸分析记录id

Responses

爆炸分析详情-分页楼层数据详情

path Parameters
projectId
required
integer <int64>

项目ID

id
required
integer <int64>

爆炸分析记录id

query Parameters
name
string

楼层名称

pageIndex
string
Default: null

页码

pageSize
string
Default: null

每页数量

Responses

爆炸分析详情-所有楼层-构件id集合

path Parameters
projectId
required
integer <int64>

项目ID

id
required
integer <int64>

爆炸分析记录id

Responses

爆炸分析详情-全量楼层数据详情

path Parameters
projectId
required
integer <int64>

项目ID

id
required
integer <int64>

爆炸分析记录id

query Parameters
name
string

楼层名称

Responses

[openAPIV3]-转换记录相关接口

查询最新的转换记录

查询文件最新的转换记录接口

path Parameters
projectId
required
integer <int64>

项目ID

fileVersionId
required
string
Example: 123

文件版本ID

query Parameters
serviceType
integer <int32>
Example: serviceType=1

数据服务类型[可选]

Responses

查询所有版本的转换记录

查询文件所有版本的转换记录接口

path Parameters
projectId
required
integer <int64>

项目ID

fileVersionId
required
string
Example: 123

文件版本ID

query Parameters
serviceType
required
integer <int32>
Example: serviceType=1

数据服务类型[必选]

Responses

[openapi]-shape-file-processing-shape文件处理接口

关键字查询数据集列表

关键字查询数据集列表

path Parameters
projectId
required
integer <int64>

项目ID

query Parameters
datasetId
integer <int64>

数据集ID

keyword
required
string

搜索关键字

type
string
Default: null

查询类型,1.默认name (关键字会在name字段中查询);2.alias(关键字会在alias别名字段中查询); 3.either关键字会在name和alias中查询,有一个命中就会返回; 4.fullMatch 名称全匹配查询

publishStatues
integer <int32>

发布状态

serviceType
integer <int32>
pageIndex
integer <int32>
Default: 1

分页页码

pageSize
integer <int32>
Default: 10

每页数量

Responses

[openapi]-bim-model-data-bim模型数据信息接口

获取模型构件属性

获取模型构件属性接口, 支持bim文件转换后发布的3dtiles服务以及模型集成的3dtiles服务

path Parameters
projectId
required
integer <int64>

项目id

serviceId
required
integer <int64>

图层id,服务Id

elementId
required
string

构件ID

Responses

获取模型构件树

获取模型构件树接口, 支持bim文件转换后发布的3dtiles服务以及模型集成的3dtiles服务

path Parameters
projectId
required
integer <int64>
Example: 11111

项目id

serviceId
required
integer <int64>
Example: 20002020222

服务id|图层id

Responses

[openapi]-scene-subject-management-场景主题管理API接口

场景主题列表--不分页

查询项目下的所有场景主题接口

path Parameters
projectId
required
integer <int64>

项目ID

query Parameters
name
string

场景主题名称(包含)

header Parameters
x-tenant-id
required
integer <int64>
x-user-id
required
string

Responses

[openapi]-category-type-专题API接口

专题列表

专题列表查询接口

path Parameters
projectId
required
integer <int64>

项目Id

query Parameters
categoryName
string

专题名字

Responses

[openapi]-service-category-服务目录API接口

服务目录列表

服务目录列表查询接口

path Parameters
projectId
required
integer <int64>

项目Id

categoryId
required
integer <int64>

专题Id

query Parameters
dirName
string

服务目录名字

parentId
integer <int64>

父目录Id

Responses

[openapi]-common-type-类型接口

第三方服务来源字典

第三方服务来源字典接口

Responses