Mengubah properti target image | PUT /target/<target_id>
Mengubah properti target image yang sesuai dengan target_id. Parameter diubah dalam bentuk HTTP patch, dan parameter yang tidak berubah tetap tidak berubah.
Action
PUT /target/<target_id>
Autentikasi
Http Header
Content-Type=application/json
HTTP Header: Authorization (ketika menggunakan autentikasi API Key Token)
Parameter request
| Field | Type | Required | Description |
|---|---|---|---|
| image | String(base64) | Yes | String base64 encoded dari image content. Mendukung image format JPG dan PNG. Ukuran image maksimum 2MB. |
| active | String | No | "1" untuk mengaktifkan target, "0" untuk menonaktifkan target. Default adalah "1". |
| name | String | Yes | Target name. Hanya mendukung huruf Inggris, tanda baca Inggris, dan angka. Panjang minimum 1 karakter, maksimum 64 karakter. |
| size | String(Float) | Yes | Lebar recognition image (unit cm). Tinggi recognition image akan dihitung otomatis oleh sistem berdasarkan image yang diupload. Ukuran recognition image sesuai dengan ukuran virtual content. Default 20. |
| meta | String | Yes | Umumnya digunakan untuk menyimpan informasi AR content dalam format text string. Default adalah "". Misalnya: informasi JSON objek yang dikenali, base64 encoding image, atau URL download file besar di cloud storage. Maksimum 2MB. |
| type | String (Float) | Yes | Harus dikonfigurasi tetap sebagai string "ImageTarget". Perhatikan bahwa huruf besar-kecil harus persis sama. |
| allowSimilar | String | No | Apakah memaksa mengizinkan penambahan jika ada image serupa. Default 0. Image serupa dapat memengaruhi hasil recognition, sehingga disarankan menggunakan default. |
Catatan
- image dibatasi maksimum 2MB.
- meta dibatasi maksimum 2MB.
Contoh request
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"
}
Contoh response
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
}
Field response
| Field | Description |
|---|---|
| statusCode | Status code 0 berarti autentikasi benar. Untuk informasi lebih lanjut, lihat Status code. |
| result | Error message atau informasi target image |
| timestamp | Waktu server saat response dikembalikan. Menggunakan format Unix timestamp dalam milidetik |
| result.targetId | ID unik target image |
| result.trackingImage | String base64 encoded dari tracking image |
| result.name | Target name |
| result.size | Lebar recognition image (unit cm). Tinggi recognition image akan dihitung otomatis oleh sistem berdasarkan image yang diupload. Ukuran recognition image sesuai dengan ukuran overlaid virtual content |
| result.meta | Informasi tambahan base64 encoded, misalnya string yang dihasilkan setelah JSON string di-base64 encoding |
| result.type | Tetap sebagai ImageTarget |
| result.active | "1" aktif, "0" nonaktif |