Zielbildeigenschaften ändern | PUT /target/<target_id>
Ändert die Eigenschaften des Zielbildes, das target_id entspricht. Parameter werden in Form von HTTP patch geändert, und unveränderte Parameter bleiben unverändert.
Action
PUT /target/<target_id>
Authentifizierung
Http Header
Content-Type=application/json
HTTP Header: Authorization (bei Authentifizierung mit API Key Token)
Anfrageparameter
| Field | Type | Required | Description |
|---|---|---|---|
| image | String(base64) | Yes | Base64-codierte Zeichenfolge des Bildinhalts. Bilder im JPG- und PNG-Format werden unterstützt. Die maximale Bildgröße beträgt 2MB. |
| active | String | No | "1" zum Aktivieren des Ziels, "0" zum Deaktivieren des Ziels. Standardwert ist "1". |
| name | String | Yes | Zielname. Es werden nur englische Buchstaben, englische Satzzeichen und Ziffern unterstützt. Mindestlänge 1 Zeichen, maximale Länge 64 Zeichen. |
| size | String(Float) | Yes | Breite des Erkennungsbildes (Einheit: cm). Die Höhe des Erkennungsbildes wird vom System anhand des hochgeladenen Bildes automatisch berechnet. Die Größe des Erkennungsbildes entspricht der Größe des virtuellen Inhalts. Standardwert 20. |
| meta | String | Yes | Wird allgemein verwendet, um AR-Inhaltsinformationen im Textzeichenfolgenformat zu speichern. Standard ist "". Zum Beispiel: JSON-Informationen des erkannten Objekts, Base64-Codierung eines Bildes oder URL-Downloadadresse einer großen Datei im Cloud-Speicher. Maximal 2MB. |
| type | String (Float) | Yes | Muss fest als Zeichenfolge "ImageTarget" konfiguriert werden. Die Groß-/Kleinschreibung muss exakt übereinstimmen. |
| allowSimilar | String | No | Ob das Hinzufügen erzwungen erlaubt wird, wenn ähnliche Bilder vorhanden sind. Standard 0. Ähnliche Bilder können Erkennungsergebnisse beeinflussen, daher wird der Standard empfohlen. |
Anmerkung
- image ist auf maximal 2MB begrenzt.
- meta ist auf maximal 2MB begrenzt.
Anfragebeispiel
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"
}
Antwortbeispiel
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
}
Antwortfelder
| Feld | Beschreibung |
|---|---|
| statusCode | Statuscode. 0 bedeutet, dass die Authentifizierung korrekt ist. Weitere Informationen siehe Statuscodes. |
| result | Fehlermeldung oder Zielbildinformationen |
| timestamp | Serverzeit beim Zurückgeben der Antwort. Verwendet Unix timestamp-Format in Millisekunden |
| result.targetId | Eindeutige ID des Zielbildes |
| result.trackingImage | Base64-codierte Zeichenfolge des Tracking-Bildes |
| result.name | Zielname |
| result.size | Breite des Erkennungsbildes (Einheit: cm). Die Höhe des Erkennungsbildes wird vom System anhand des hochgeladenen Bildes automatisch berechnet. Die Größe des Erkennungsbildes entspricht der Größe des überlagerten virtuellen Inhalts |
| result.meta | Base64-codierte Zusatzinformationen, zum Beispiel eine Zeichenfolge, die nach Base64-Codierung einer JSON-Zeichenfolge erzeugt wird |
| result.type | Fest auf ImageTarget gesetzt |
| result.active | "1" aktiviert, "0" deaktiviert |