대상 이미지 속성 수정 | PUT /target/<target_id>
target_id에 해당하는 대상 이미지 속성을 수정합니다. HTTP patch 형식으로 parameter를 수정하며, 변경되지 않은 parameter는 그대로 유지됩니다.
Action
PUT /target/<target_id>
인증
Http Header
Content-Type=application/json
HTTP Header: Authorization(API Key Token 방식 인증을 사용할 때)
요청 parameter
| Field | Type | Required | Description |
|---|---|---|---|
| image | String(base64) | Yes | 이미지 내용의 base64 encoded string. JPG 및 PNG 형식 image를 지원합니다. 이미지 최대 크기는 2MB입니다. |
| active | String | No | "1"은 target 활성화, "0"은 target 비활성화. 기본값은 "1"입니다. |
| name | String | Yes | target name. 영어 문자, 영어 문장 부호, 숫자만 지원합니다. 길이는 최소 1자, 최대 64자입니다. |
| size | String(Float) | Yes | recognition image width(단위 cm). recognition image의 높이는 업로드한 image에 따라 시스템이 자동으로 계산합니다. recognition image의 크기는 virtual content의 크기와 대응합니다. 기본값 20. |
| meta | String | Yes | 일반적으로 AR content 정보를 text string 형식으로 저장하는 데 사용됩니다. 기본값은 ""입니다. 예: 인식 대상의 JSON 정보, image의 base64 encoding, 또는 cloud storage에 있는 대용량 파일의 URL download address. 최대 2MB. |
| type | String (Float) | Yes | 반드시 문자열 "ImageTarget"으로 고정 구성해야 합니다. 대소문자는 완전히 동일해야 합니다. |
| allowSimilar | String | No | 유사 image가 존재할 때 강제로 추가를 허용할지 여부. 기본값 0. 유사 image는 recognition 결과에 영향을 줄 수 있으므로 기본값 사용을 권장합니다. |
참고
- 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
}
응답 field
| 필드 | 설명 |
|---|---|
| statusCode | status code 0은 인증이 올바름을 의미합니다. 자세한 내용은 Status code를 참조하십시오. |
| result | error message 또는 대상 이미지 정보 |
| timestamp | response 반환 시 server-side time. Unix timestamp 형식을 사용하며 단위는 millisecond |
| result.targetId | 대상 이미지의 고유 ID |
| result.trackingImage | tracking image의 base64 encoded string |
| result.name | target name |
| result.size | recognition image width(단위 cm). recognition image의 높이는 업로드한 image에 따라 시스템이 자동으로 계산합니다. recognition image의 크기는 overlay virtual content의 크기와 대응합니다 |
| result.meta | base64 encoded additional information. 예: JSON string을 base64 encoding한 후 생성된 string |
| result.type | ImageTarget으로 고정 |
| result.active | "1" 활성화, "0" 비활성화 |