跳到主要内容

GET 按来源查询标注

GET 查询。query 参数见接口参考。

接口编码所需范围后端接口
project.drawing.annotations.by-sourceproject:readGET /v1/drawing/annotations/by-source(comap-project)

请求参数(query)

字段类型必填说明
sourceTypestring是—
sourceIdinteger(int64)是—

「必填」仅反映接口规格声明的部分。服务内还有未体现在规格里的校验, 标「—」不等于可以不传;租户在主站配置的字段必填不约束本接口。 详见必填字段的判定与字段清单与自定义字段。

请求示例

curl -X POST https://open.risemap.cn/v1/api/invoke \
-H "Authorization: Bearer <访问令牌>" \
-H "Content-Type: application/json" \
-d '{
"apiCode": "project.drawing.annotations.by-source",
"query": {
"sourceType": "string",
"sourceId": "1961000000000000001"
}
}'

响应 data 字段

字段类型必填说明
idstring—标注ID
sourceTypestring—来源类型 REVIEW_ISSUE/DISTRIBUTION/CHANGE
sourceIdstring—来源业务ID
baseFileIdstring—底图file_id
annotationDatastring—标注JSON数据
resultImageFileIdstring—标注合成图file_id
remarkstring—备注
createTimestring(date-time)—创建时间
updateTimestring(date-time)—更新时间

错误处理​

响应统一信封 { code, message, data },code == 200 为成功。以下是本接口可能返回的开放平台层错误:

错误码说明可重试
92101访问凭证无效否
92201接口未登记或已停用否
92202超出凭证授权范围——本接口需 project:read否
92204绑定员工无此接口的功能权限否
92203上游服务调用失败是
92301请求过于频繁是

除此之外,comap-project 自身的业务校验失败会原样透传其业务码与提示 (如字段校验、状态不允许、数据不存在),这类码不在开放平台的号段内, 以响应里的 message 为准。完整的平台层错误码见错误码说明。

← 返回图纸画布标注