修改目标图像属性 | PUT /target/<target_id>
修改 target_id 对应的目标图像属性。Http patch 形式修改参数,没有变化的参数保持不变。
Action
PUT /target/<target_id>
认证
需要
Http Header
Content-Type=application/json
HTTP Header: Authorization (当采用 API Key Token 方式认证)
请求参数
| Field | Type | Required | Description |
|---|---|---|---|
| image | String(base64) | Yes | 图像内容的 base64 编码字符串,支持 JPG 和 PNG 格式图像。图片最大 2MB。 |
| active | String | No | "1" 来启用目标,"0" 来停用目标。默认为 "1" |
| name | String | Yes | 目标名称,仅支持英文字母、英文标点、数字,长度最小 1 个字符,最大 64 个字符 |
| size | String(Float) | Yes | 识别图宽度(单位 cm )。识别图的高度将由系统根据您上传的图片自动计算。识别图的大小和虚拟内容的大小对应。默认 20 |
| meta | String | Yes | 一般用于存储 AR 内容信息,文本字符串格式,默认是""。 例如:识别物的 JSON 信息,图片的 base64 编码,或者是大文件在云存储的 URL 下载地址。最大 2MB。 |
| type | String (Float) | Yes | 必须固定配置为字符串 "ImageTarget",注意大小写需要完全一样。 |
| allowSimilar | String | No | 如果存在相似图是否强制允许添加,默认 0.相似图可能影响识别结果,建议采用默认。 |
注意
- image 限制最大 2MB.
- meta 限制最大 2MB.
请求示例
PUT /target/e61db301-e80f-4025-b822-9a00eb48d8d2 HTTP/1.1
Host:
Date: Mon, 1 Jan 2018 00:00:00 GMT
Content-Type: application/json
{
"active":"1",
"name":"easyar",
"size":"5",
"meta":"496fbbabc2b38ecs3460a...",
"timestamp": 1514736000000,
"appKey": "test_app_key",
"signature": "89985e2420899196db5bdf16b3c2ed0922c0c221"
}
返回示例
HTTP/1.1 200 OK
Content-Type: application/json
{
"statusCode": 0,
"result": {
"target": {
"targetId":"e61db301-e80f-4025-b822-9a00eb48d8d2",
"trackingImage":"/9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAAMCAgM...",
"name": "easyar",
"size": "5",
"meta": "496fbbabc2b38ecs3460a...",
"type": "ImageTarget",
"date": "2016-06-15T09:56:30.000Z",
"active":"1",
"trackableRate": 0,
"detectableRate": 0,
"detectableDistinctiveness":0,
"detectableFeatureCount": 0,
"trackableDistinctiveness": 0,
"trackableFeatureCount": 0,
"trackableFeatureDistribution": 0,
"trackablePatchContrast": 0,
"trackablePatchAmbiguity": 0
}
},
"timestamp": 1514736000000
}
返回字段
| 字段 | 描述 |
|---|---|
| statusCode | 状态码 0 表示认证正确,更多参考 状态码 |
| result | 错误消息,或者目标图信息 |
| timestamp | 响应返回时的服务器端时间。使用 Unix 时间戳格式,以毫秒为单位 |
| result.targetId | 目标图的唯一 ID |
| result.trackingImage | 跟踪图像的 base64 编码字符串 |
| result.name | 目标名称 |
| result.size | 识别图宽度(单位 cm )。识别图的高度将由系统根据您上传的图片自动计算。识别图的大小和叠加虚拟内容的大小对应 |
| result.meta | base64 编码的附加信息,例如将 json 字符串 base64 编码后生成的字符串 |
| result.type | 固定为 ImageTarget |
| result.active | "1" 启用,"0" 停用 |
错误码
参见 状态码以及错误码大全