Изменение свойств целевого изображения | PUT /target/<target_id>
Изменение свойств целевого изображения, соответствующего target_id. Параметры изменяются в форме HTTP patch, неизменяемые параметры сохраняются.
Action
PUT /target/<target_id>
Аутентификация
HTTP-заголовок
Content-Type=application/json
HTTP-заголовок: Authorization (при аутентификации с помощью API Key Token)
Параметры запроса
| Поле | Тип | Обязательный | Описание |
|---|---|---|---|
| image | String(base64) | Да | Строка в кодировке base64 содержимого изображения. Поддерживаются форматы JPG и PNG. Максимальный размер изображения — 2 МБ. |
| active | String | Нет | "1" для включения цели, "0" для отключения цели. По умолчанию "1". |
| name | String | Да | Название цели. Поддерживаются только латинские буквы, английская пунктуация, цифры. Минимальная длина — 1 символ, максимальная — 64 символа. |
| size | String (Float) | Да | Ширина распознаваемого изображения (в см). Высота распознаваемого изображения будет автоматически рассчитана системой на основе загруженного изображения. Размер распознаваемого изображения соответствует размеру виртуального содержимого. По умолчанию 20. |
| meta | String | Да | Обычно используется для хранения информации AR, в формате текстовой строки. По умолчанию "". Например: JSON-информация распознаваемого объекта, base64-кодирование изображения или URL-адрес для загрузки больших файлов из облачного хранилища. Максимум 2 МБ. |
| type | String (Float) | Да | Должно быть строго установлено как "ImageTarget". Обратите внимание на точное соответствие регистра. |
| allowSimilar | String | Нет | Разрешить ли принудительное добавление при наличии похожего изображения. По умолчанию 0. Похожие изображения могут влиять на результаты распознавания, рекомендуется использовать значение по умолчанию. |
Примечание
- Максимальный размер image — 2 МБ.
- Максимальный размер meta — 2 МБ.
Пример запроса
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 | Ширина распознаваемого изображения (в см). Высота распознаваемого изображения будет автоматически рассчитана системой на основе загруженного изображения. Размер распознаваемого изображения соответствует размеру накладываемого виртуального содержимого |
| result.meta | Base64-кодированная дополнительная информация, например, строка, сгенерированная после base64-кодирования JSON-строки |
| result.type | Фиксировано как ImageTarget |
| result.active | "1" включено, "0" отключено |