Изменение свойств целевого изображения | 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 timestamp в миллисекундах |
| result.targetId | Уникальный ID целевого изображения |
| result.trackingImage | Base64-кодированная строка отслеживаемого изображения |
| result.name | Имя цели |
| result.size | Ширина изображения распознавания (единица: cm). Высота изображения распознавания автоматически рассчитывается системой на основе загруженного изображения. Размер изображения распознавания соответствует размеру наложенного виртуального контента |
| result.meta | Base64-кодированная дополнительная информация, например строка, созданная после base64-кодирования JSON-строки |
| result.type | Фиксировано как ImageTarget |
| result.active | "1" включено, "0" отключено |