Modify target image attributes | PUT /target/<target_id>
Modify the attributes of the target image corresponding to target_id. Use HTTP patch to modify parameters, keeping unchanged parameters as they are.
Action
PUT /target/<target_id>
Authentication
Required
Http header
Content-Type=application/json
HTTP Header: Authorization (when using API key token authentication)
Request parameters
| Field | Type | Required | Description |
|---|---|---|---|
| image | String(base64) | Yes | Base64-encoded string of image content, supporting JPG and PNG formats. Maximum image size 2MB. |
| active | String | No | "1" to activate target, "0" to deactivate target. Default is "1". |
| name | String | Yes | Target name, supporting only English letters, English punctuation, and numbers. Minimum length 1 character, maximum 64 characters. |
| size | String(Float) | Yes | Width of the recognition image (unit: cm). Height will be automatically calculated based on the uploaded image. Recognition image size corresponds to virtual content size. Default 20. |
| meta | String | Yes | Typically used to store AR content information in text string format. Default is "". Example: JSON information of recognized objects, base64-encoded images, or cloud storage URLs for large files. Maximum 2MB. |
| type | String(Float) | Yes | Must be fixed to the string "ImageTarget". Note: case sensitivity is required. |
| allowSimilar | String | No | Whether to forcibly allow addition if similar images exist. Default 0. Similar images may affect recognition accuracy; default setting is recommended. |
Note
- image limited to maximum 2MB.
- meta limited to maximum 2MB.
Request example
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"
}
Return example
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
}
Return fields
| Field | Description |
|---|---|
| statusCode | Status code 0 indicates correct authentication. For more details, refer to status code |
| result | Error message or target image information |
| timestamp | Server-side time when the response is returned. Uses Unix timestamp format in milliseconds |
| result.targetId | Unique ID of the target image |
| result.trackingImage | Base64-encoded string of the tracking image |
| result.name | Target name |
| result.size | Width of the recognition image (in cm). The height of the recognition image will be automatically calculated by the system based on the uploaded image. The size of the recognition image corresponds to the size of the overlaid virtual content |
| result.meta | Base64-encoded additional information, such as a string generated by base64-encoding a JSON string |
| result.type | Fixed as ImageTarget |
| result.active | "1" for enabled, "0" for disabled |