Modify target image attribute | PUT /target/<target_id>
Modify the attributes of the target image corresponding to target_id. Use Http patch to modify parameters, keeping unchanged parameters intact.
Action
PUT /target/<target_id>
Authentication
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 | Use "1" to enable the target and "0" to disable it. Default is "1". |
| name | String | Yes | Target name, only supports English letters, English punctuation, numbers. Minimum length 1 character, maximum 64 characters. |
| size | String (Float) | Yes | Target image width (in cm). The height will be automatically calculated by the system based on the uploaded image. The target image size corresponds to the virtual content size. Default is 20. |
| meta | String | Yes | Typically used to store AR content information, in text string format, default is an empty string. For example: JSON information of the target, base64 encoding of an image, or a URL download address for large files in cloud storage. Maximum 2MB. |
| type | String | Yes | Must be fixed to the string "ImageTarget", note that case sensitivity is required. |
| allowSimilar | String | No | Whether to force allowing addition if similar images exist. Default is 0. Similar images may affect recognition results, so using default is recommended. |
Note
- image is limited to a maximum of 2MB.
- meta is limited to a maximum of 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"
}
Response 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
}
Response fields
| Field | Description |
|---|---|
| statusCode | Status code 0 indicates correct authentication. For more information, refer to Status code |
| result | Error message or target image information |
| timestamp | Server 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 | Target image width (in cm). The height is automatically calculated by the system based on the uploaded image. The target image size corresponds to the overlaid virtual content size |
| 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 |