Objekte und Attribute
Ein Objekt ist das Schema eines Datensatztyps. Es besitzt eine stabile Identität, lokalisierte Namen, eine Anzeigevorlage und typisierte Attribute. Datensätze werden immer gegen die aktuelle Objektdefinition validiert.
Semantische Kennungen und ganze Zahlen
Die Attributtypen license_plate und vin speichern freien Text. Leerzeichen, Groß- und
Kleinschreibung sowie Satzzeichen bleiben erhalten. Es gibt keine automatische Prüfung von
Kennzeichenformat, FIN-Länge oder Prüfziffer. Wie bei text können Länge, Muster, Standardwert,
Pflichtfeld und Eindeutigkeit konfiguriert werden. Ein benutzerdefiniertes Objekt darf mehrere
Attribute dieser Typen enthalten. REST verwendet Textfilter; GraphQL stellt die Werte als String dar.
Ein number-Attribut kann mit config.is_integer: true auf ganze Zahlen beschränkt werden
(Standard: false). Auch 4.0 ist gültig; Bruchteile und als Text übermittelte Zahlen werden
ohne Rundung abgelehnt. Minimum, Maximum, Standardwert, optionale Werte und Eindeutigkeit behalten
ihre bisherige Bedeutung. Enthalten vorhandene Werte Bruchteile, schlägt das Aktivieren der
Beschränkung mit HTTP 422 fehl. Schema, Datensätze und Definitionsversion bleiben unverändert.
Korrigieren Sie zuerst die Werte und wiederholen Sie die Schemaänderung. Mit false werden
Bruchteile wieder erlaubt.
Objektstruktur
Objektdefinitionen verwenden den gemeinsamen Definitionsvertrag. Dieser
Ausschnitt zeigt ihre Metadaten; die vollständige Antwort enthält zusätzlich die effektiven
attributes und Zeitstempel.
{
"id": "7f8e0d3a-1b2c-4d5e-8f90-a1b2c3d4e5f6",
"slug": "equipment",
"resource_type": "object",
"name": {
"en": { "singular": "Equipment item", "plural": "Equipment" },
"de": { "singular": "Anlage", "plural": "Anlagen" }
},
"display_template": "{{name}} ({{asset_tag}})",
"icon": "toolbox",
"color": "orange",
"map_marker_fields": ["asset_tag", "category"],
"managed_by": "tenant",
"schema_policy": "editable",
"is_readonly": false,
"lock_version": 0,
"is_relationship_target": true
}
| Feld | Bedeutung |
|---|---|
id | Unveränderliche, von Tourfold vergebene UUID. Für dauerhafte Integrationen empfohlen. |
slug | Veränderlicher API-Bezeichner, eindeutig über alle Definitionen des Workspace hinweg, einschließlich Fahrzeugdefinitionen. |
name | Substantiv je kanonischem Sprach-Tag mit Singular und Plural. |
display_template | Optionale Datensatzbezeichnung aus {{attribute_slug}}-Platzhaltern. Ohne Vorlage verwenden benutzerdefinierte Objekte die automatische Benennung; eine ausdrückliche Vorlage hat Vorrang. |
icon | Optionaler Icon-Schlüssel aus dem Tourfold-Icon-Katalog, zum Beispiel truck: Kleinbuchstaben, Ziffern und einzelne Bindestriche, höchstens 64 Zeichen. Fehlt, wenn nicht gesetzt; Clients zeigen dann ein Standard-Icon, wie auch bei Schlüsseln, die sie nicht kennen. |
color | Optionale Icon-Farbe aus der Palette gray, red, orange, amber, green, teal, blue, indigo, violet, pink. Fehlt, wenn nicht gesetzt. |
map_marker_fields | Attribut-Slugs, die in dieser Reihenfolge angezeigt werden, wenn die Kartenmarkierung eines Datensatzes geöffnet wird. Siehe Kartenmarkierungen. Leer, wenn keine festgelegt sind. |
managed_by | Vom Server festgelegter Eigentümer: tenant, system oder plugin. |
managed_by_plugin | Plugin-ID, beispielsweise bw; nur bei managed_by: "plugin" vorhanden. |
schema_policy | editable für Schemata des Tenants, locked für system- oder pluginverwaltete Schemata. Gesperrte Schemata können weder gelöscht noch bearbeitet werden, auch nicht Namen, Felder, Auswahlwerte und Anzeigevorlagen; nur icon, color und map_marker_fields bleiben bearbeitbar. |
is_readonly | Gibt an, ob Datensatz-Schreibvorgänge über die Custom-Object-API verboten sind. |
lock_version | Version des Objektschemas für optionales optimistisches Locking. |
attributes | Eigene Attribute sowie Systemattribute und verwaltete Attribute. |
Dieselben Formen von managed_by, optionalem managed_by_plugin und schema_policy erscheinen auch bei
Fahrzeugdefinitionen, Aufgabendefinitionen und in den Antworten von /api/v2/definitions/all. Sie
regeln nur die Schemabearbeitung: Datensatzwerte bleiben bearbeitbar, sofern is_readonly und die
Berechtigungen des Aufrufers es zulassen. Eigentümerschaft und Sperrung legt der Server fest. Wird eines
dieser Felder beim Anlegen oder Ändern einer Objektdefinition mitgesendet, liefert die API einen
feldbezogenen 422-Fehler, ebenso bei anderen unbekannten Request-Feldern.
Auch ein Attribut hat eine unveränderliche id, einen veränderlichen slug, eine lokalisierte
name-Map, einen festen type und eine optionale config. Attributnamen sind Feldbezeichnungen;
deshalb verweist jede Sprache direkt auf einen String statt auf Singular und Plural.
Objekt-, Fahrzeug- und Aufgabendefinitionen geben ihre effektiven Felder in einer gemeinsamen Liste
attributes aus, einschließlich id, created_at, updated_at und lock_version. Native
Aufgabenfelder stehen ebenfalls in dieser Liste; eine separate Liste native_fields gibt es nicht.
is_system_managed schützt die Schemadefinition, während is_readonly die Schreibbarkeit des Wertes
beschreibt. Der native Aufgabentitel title ist beispielsweise systemverwaltet, bleibt aber über den
typisierten Aufgabenaufruf beschreibbar. Native Aufgabenwerte bleiben auf der obersten Ebene,
benutzerdefinierte Werte unter data; die zusammengeführten Metadaten ändern keine Datensatzpfade.
Strukturierte native Aufgabenfelder (linked_records, visit oder interaction) verwenden den
nur für Antworten vorgesehenen Typ json. Ihr Wert richtet sich nach dem jeweiligen
Aufgaben-Anfrage- oder Antwortschema. Sie haben keine config, Optionen oder Statuswerte und
können nicht als benutzerdefinierte Attribute angelegt werden.
In den Einstellungen stehen zuerst Systemattribute, dann Plugin-Attribute und zuletzt eigene
Attribute. Innerhalb jeder Gruppe bleibt die Definitionsreihenfolge erhalten. Die technische
Zeile lock_version wird ausgeblendet. Diese Darstellung ändert weder Abfragesortierung noch
Datensatzberechtigungen.
Jede Attributantwort enthält außerdem zwei Felder zur Abfrageermittlung:
| Feld | Bedeutung |
|---|---|
is_sortable | Gibt an, ob nach dem Attribut direkt auf diesem Objekt sortiert werden kann. |
filter_operators | Exakte REST-Operatornamen, die ein skalarer Filter akzeptiert. Eine leere Liste bedeutet, dass ein verschachtelter Referenzfilter verwendet werden muss oder das Feld nicht filterbar ist. |
GraphQL erzeugt seine Filter- und Sortier-Inputs aus demselben Fähigkeitskatalog. In GraphQL beginnt jeder Operator mit einem Unterstrich; Semantik und Typeinschränkungen sind ansonsten identisch.
Objekt- und Attribut-Slugs beginnen mit einem Kleinbuchstaben und enthalten nur Kleinbuchstaben, Zahlen
und Unterstriche (^[a-z][a-z0-9_]*$). Definitions-Slugs dürfen höchstens 63 Zeichen enthalten,
Attribut- und Relationsseiten-Slugs höchstens 200. Die Wörter self und this sind reserviert.
Namen mit führendem _ sind für Plattform- und GraphQL-Felder reserviert. Das Präfix plugin_
ist für pluginverwaltete Definitionen reserviert, auch bevor das Plugin aktiviert wird;
bei Attributen ist es zulässig. Die frühere Einschränkung für so_ entfällt. Der Name all
ist nur bei Fahrzeugdefinitionen reserviert; Objektdefinitionen und Attribute dürfen ihn verwenden.
Attribut- und Relationsseiten-Slugs dürfen außerdem nicht die Plattformfelder id, display_name, created_at,
updated_at, lock_version, is_system_managed oder is_readonly verwenden.
Attributtypen
Tourfold stellt eine abgeschlossene Typmenge statt rohem JSON Schema bereit. Dadurch bleiben Validierung und generierte Clients vorhersehbar.
Die folgende Tabelle ist der kompakte Vertrag. Hinweise zum Schemadesign, typspezifische Konfiguration, kanonische Schreib-/Leseformen, GraphQL-Zuordnung und Auswirkungen auf Integrationen finden Sie im Attribut-Leitfaden.
| Typ | Wert beim Schreiben | Wichtige Konfiguration |
|---|---|---|
text | String | pattern, min_length, max_length |
license_plate, vin | Freier Text | pattern, min_length, max_length; kein vorgegebenes Format |
number | Zahl | minimum, maximum, is_integer |
date | Vollständiges RFC-3339-Datum, z. B. 2026-08-26 | — |
date_time | RFC-3339-Zeitstempel | — |
boolean | Boolean | — |
select | Options-UUID/aktueller Wert; bei Mehrfachauswahl ein Array | is_multiselect, min_items, max_items |
state | Status-UUID/aktueller Wert | — |
capacity | Zahl | unit_kind und unit_ref |
measure | Zahl | unit_ref |
currency | Zahl | currency_code, z. B. EUR |
rating | Zahl | Positives max |
email | String | — |
phone | Telefonnummer im E.164-Format | — |
tags | Array aus Tag-IDs, Bezeichnungen oder Referenzobjekten | Verwaltung über die Tags-API |
required_skills | Array aus Qualifikations-IDs, Bezeichnungen oder Referenzobjekten | Verwaltung über die Skills-API |
provided_skills | Array aus Qualifikations-IDs, Bezeichnungen oder Referenzobjekten | Verwaltung über die Skills-API |
relationship | Einzelne Ziel-UUID/Referenz für To-one; Arrays für To-many | target, is_multiselect, optional reverse; target: "user" erfasst Workspace-Benutzer |
location | Adresse, Koordinaten oder Tracking-Objekt | Feste strukturierte Form; optional marker_icon, marker_color |
raw_json | Beliebiges JSON-Objekt, -Array, -String, -Zahl oder -Boolean, gespeichert und zurückgegeben als JSON | Plattformweite Größen-, Tiefen- und Elementgrenzen; siehe Rohe JSON-Dokumente |
rich_text | HTML-Fragment in der unterstützten Formatierungsteilmenge; reiner Text wird zu einem Absatz | Beim Schreiben normalisiert; siehe Formatierter Text |
full_name | Objekt mit optionalem title, first_name, last_name | Mindestens ein Namensbestandteil; siehe Vollständiger Name |
links | Objekt mit einem primary-Link und geordneten alternatives, jeweils {url, label} | Nur sichere Schemata, 10 Alternativen; siehe Links |
Gemeinsame Konfiguration
config beschreibt das Verhalten und legt keine Speicher- oder Indexierungsdetails offen.
| Eigenschaft | Gültig für | Verhalten |
|---|---|---|
is_required | Alle Typen | Verlangt einen Wert; Referenzsammlungen benötigen mindestens einen Eintrag. |
is_unique | Unterstützte einwertige String-/Zahltypen | Erklärt Eindeutigkeit und ermöglicht die Suche über einen fachlichen Schlüssel. Nach Erstellung unveränderlich. Für raw_json, rich_text, full_name und links nie verfügbar. |
default | Typen mit sinnvollem Standardwert | Wird verwendet, wenn ein Datensatz das Attribut auslässt. Ein raw_json-Standardwert ist ein beliebiges JSON-Dokument innerhalb der Plattformgrenzen. |
is_multiselect | select, relationship | Erlaubt mehrere ausgewählte Werte oder verknüpfte Datensätze. |
Eine Eigenschaft is_indexed gibt es bewusst nicht. Tourfold leitet Indizes aus der erklärten Absicht
ab—etwa Eindeutigkeit, Auswahlwerten, Status, Relationen und Anzeigefeldern—und verwaltet sie passend zur
Arbeitslast.
Unbekannte Konfigurationsfelder, für den Typ unzulässige Konfigurationen und unsichere reguläre
Ausdrücke liefern 422 mit einem Pointer auf das fehlerhafte Feld.
Auswahlwerte und Status
Auch Auswahlressourcen besitzen stabile Identitäten:
| Ressource | Unveränderliche Identität | Veränderlicher Bezeichner | Anzeigefelder |
|---|---|---|---|
| Auswahlwert | id | value | title |
| Status | id | value | title, erforderliches color |
Schreibvorgänge und Filter akzeptieren die UUID oder den aktuellen value. Datensatzabrufe und
Standardwerte für Auswahlfelder in Objektantworten liefern die kanonische UUID. Eine Änderung von Wert,
Titel oder Farbe erfordert daher keine Umschreibung gespeicherter Daten.
Auswahlwerte können beim Anlegen eines Objekts direkt mitgegeben werden:
{
"slug": "priority",
"type": "select",
"name": { "de": "Priorität" },
"options": [
{ "value": "normal", "title": "Normal" },
{ "value": "urgent", "title": "Dringend" }
]
}
Für schrittweise Änderungen dienen createObjectSelectOption, updateObjectSelectOption und deleteObjectSelectOption beziehungsweise die entsprechenden Statusoperationen.
Referenzwerte
Referenzen akzeptieren beim Schreiben benutzerfreundliche Bezeichner und liefern beim Lesen kanonische, aufgelöste Objekte:
| Referenz | Schreiben akzeptiert | Lesen liefert |
|---|---|---|
| Tags | UUID, Bezeichnung, {"id": "..."} oder {"label": "..."} | {"id", "label", "color"} |
| Qualifikationen | UUID, Bezeichnung, {"id": "..."} oder {"label": "..."} | {"id", "label"} |
| Relationszielobjekt | Objekt-UUID oder Slug | {"id", "slug"} |
| Relationsdatensatz | Datensatz-UUID oder {"record_id": "..."} | {"record_id", "object", "display_name"} |
Workspace-Benutzer (Relation zu user) | Benutzer-UUID oder {"record_id": "..."} | {"record_id", "object": "user", "display_name"}, dazu status für deaktivierte oder gelöschte Benutzer |
Ein syntaktisch gültiger UUID-String wird immer als ID interpretiert. Enthält ein Objekt ID und Bezeichner, hat die ID Vorrang. Beim Lesen aufgelöste Referenzobjekte können unverändert zurückgeschrieben werden.
Standortwerte
Ein location-Wert speichert eine internationale Adresse, Koordinaten oder eine Live-Tracking-Referenz:
{
"street": "Karlsplatz 1",
"street_additional": null,
"city": "Wien",
"region": null,
"postal_code": "1010",
"country_code": "AT",
"lat": 48.2004,
"lon": 16.3696,
"located_at": "2026-08-26T09:30:00Z"
}
Ein Tracking-Objekt verweist auf das Standortattribut eines anderen Datensatzes:
{
"tracking": {
"record_id": "6f3d2a10-0000-4000-8000-000000000117",
"object": "device",
"attribute": "gps"
}
}
Der Server speichert die vom Client übergebenen Werte; Geocoding erfolgt clientseitig. Um das Tracking
zu beenden, lesen Sie den aufgelösten Standort und schreiben seine konkrete Adresse bzw. Koordinaten ohne
tracking zurück. Der feste Wert ist die vom Client gewählte Momentaufnahme. Wird das gesamte
Standortattribut als null gesendet, wird der Standort entfernt; nur {"tracking":null} zu senden
ergibt einen unvollständigen Standort und wird abgelehnt.
Kartenmarkierungen
Tourfold-Karten zeichnen je Standortattribut eine eigene Ebene. Die Markierung eines Datensatzes zeigt
icon und color seines Objekts. Beim Öffnen erscheinen der display_name des Datensatzes, die
angeklickte Markierung (der Name des Standortattributs, zum Beispiel „Geparkt bei“, samt Adresse, sofern
vorhanden) und die map_marker_fields des Objekts, jeweils unter dem Namen ihres Attributs. Diese
Einstellungen ändern nur die Darstellung, nie die gespeicherten Werte.
map_marker_fields listet Attribut-Slugs in der gewünschten Reihenfolge auf, zum Beispiel
["plate_number", "color"]. Jedes Attribut darf einmal vorkommen; die Liste ist also höchstens so lang
wie die Attribute des Objekts. Ein Request nimmt höchstens 100 Einträge an
(422 field-size-invalid). Listenwertige Attribute — Tags, Skills und mehrwertige Relationen — können
nicht angezeigt werden und liefern 422 invalid-marker-field, ebenso unbekannte und doppelte Slugs. Wird
ein Attribut umbenannt, ändert sich sein Eintrag in der Liste mit; wird es gelöscht, entfällt er.
{"map_marker_fields":null} oder [] leert die Liste.
Ein Standortattribut kann seiner eigenen Ebene mit zwei optionalen config-Eigenschaften ein anderes
Aussehen geben, etwa wenn ein Objekt sowohl eine Laderampe als auch ein Büro hat:
| Eigenschaft | Verhalten |
|---|---|
marker_icon | Icon-Schlüssel aus dem Tourfold-Icon-Katalog, zum Beispiel warehouse, mit denselben Regeln wie das icon eines Objekts. Fehlt er, wird das Icon des Objekts verwendet; für unbekannte Schlüssel zeichnen Clients eine einfache Markierung. |
marker_color | Palettenfarbe mit denselben Werten wie die color eines Objekts. Fehlt sie, wird die Farbe des Objekts verwendet. |
{
"slug": "dock",
"type": "location",
"name": { "de": "Laderampe" },
"config": { "marker_icon": "warehouse", "marker_color": "teal" }
}
{"config":{"marker_icon":null}} am Attribut leert dessen eigenes Icon; ausgelassene Eigenschaften
bleiben erhalten.
Systemattribute und verwaltete Attribute
Jedes Objekt enthält vier vom Server verwaltete Attribute:
id(text)created_atundupdated_at(date_time)lock_version(number)
Jede Attributantwort enthält ausdrücklich die Booleans is_system_managed und is_readonly. Bei den
vier Systemattributen sind beide true, bei gewöhnlichen Attributen des Tenants beide false. Ihre
Werte stehen zusätzlich auf der obersten Ebene einer Datensatzantwort und dürfen nicht in data
geschrieben werden. Systemattribute sind virtuelle Plattformfelder und haben daher keine optionale
Attribut-id; gespeicherte Benutzer- und Relationsattribute tragen stabile UUIDs.
Die materialisierte Rückseite einer Relation besitzt sowohl is_system_managed: true als auch
is_readonly: true. Sie stellt Verknüpfungen für Abrufe und Traversierung bereit; Schema und
Datensatzverknüpfungen werden jedoch nur über das deklarierende Attribut auf der Besitzerseite geändert.
Siehe Relationen.
Schemas anlegen und ändern
Es gibt zwei gleichwertige Bearbeitungsstile:
| Stil | Einsatz | Operationen |
|---|---|---|
| Bulk | Ein vollständiges Objekt bereitstellen oder synchronisieren | createObjectDefinition, replaceObjectDefinition |
| Schrittweise | Ein bestehendes Feld oder einen Auswahlwert ändern | addObjectAttribute, updateObjectAttribute, deleteObjectAttribute |
Schrittweise Attribut-, Options- und Statusänderungen liefern das vollständige aktualisierte Objekt
einschließlich der neuen lock_version.
Ein Objekt definiert höchstens 50 eigene Attribute. Systemattribute und verwaltete Relationsrückseiten
zählen nicht dazu. Ein Schreibvorgang, der das Limit überschreiten würde, liefert 422 mit einem Fehler
too-many-attributes unter #/attributes.
Schrittweise Schemabearbeitung
Die Definitionsmetadaten liegen unter /api/v2/definitions/objects/{definition_ref}. UUIDs und Slugs
werden akzeptiert. Mit PATCH ändern Sie ausschließlich slug, name, display_template, icon,
color oder map_marker_fields; attributes wird in Metadaten-Patches nicht akzeptiert.
Namensänderungen werden je Sprache und Wortform zusammengeführt. Ein ausdrückliches null leert die
Vorlage, das Icon, die Farbe oder eine einzelne Übersetzung; ein ausgelassenes Feld bleibt erhalten. Eine
Namens-Map muss mindestens einen lokalisierten Namen behalten.
PATCH /api/v2/definitions/objects/equipment
Content-Type: application/merge-patch+json
{"name":{"de":{"singular":"Anlagegut"}},"display_template":null,"lock_version":3}
Felder fügen Sie mit POST …/attributes hinzu, ändern sie mit PATCH …/attributes/{attribute_ref} und
entfernen sie mit DELETE …/attributes/{attribute_ref}. Attribut-Patches für Objekte und Fahrzeuge
verwenden den gemeinsamen Vertrag UpdateAttribute. Ausgelassene Felder bleiben erhalten;
mitgesendete Options- und Status-Arrays ersetzen die jeweilige Menge. Die Antwort enthält die
vollständige aktualisierte Definition.
Systemverwaltete Attribute wie natural_id können nicht gelöscht werden. Ein Löschversuch per Slug
oder UUID liefert 422 mit dem Validierungsfehler read-only; die Definition bleibt unverändert.
Bulk-PUT ist deklaratives Ersetzen
PUT /definitions/objects/{definition_ref} ersetzt die vollständige Menge der Attribute, die diesem Objekt gehören:
- Die
ideines bestehenden Attributs mitsenden, um seine Identität über eine Slug-Änderung hinweg zu erhalten. - Fehlt die
idund existiert der Slug bereits, behält Tourfold die Identität dieses Attributs bei. Passen weder ID noch Slug, legt Tourfold ein neues Attribut an. - Die vollständige Menge aus
slug,nameundattributesmitsenden. Fehlendeattributeswerden mit 422 abgelehnt;[]entfernt ausdrücklich alle eigenen Attribute. - Ein eigenes Attribut auslassen, um es zu löschen.
display_template,iconundcolorbeschreiben das endgültige Schema; ein ausgelassenes Feld wird geleert. Umbenennungen im Bulk, auch Vertauschungen, erhalten die Werte über die Attribut-ID. Eine fehlgeschlagene Ersetzung setzt Metadaten, Schema und Werte gemeinsam zurück.- Bestehende Options-/Status-IDs mitsenden, um sie über Wertänderungen hinweg zu erhalten. Ein
Auswahlwert ohne ID mit demselben
valuebehält seine Identität; ausgelassene Werte werden gelöscht. - Verwaltete Relationsrückseiten auslassen. Sie gehören nicht zur eigenen Ersetzungsmenge des Zielobjekts und bleiben bestehen.
Das Mitsenden oder direkte Ändern einer verwalteten Rückseite liefert
422 relationship-reverse-managed und nennt das besitzende Objekt und Attribut. Änderungen erfolgen
über die Relationsdeklaration des Besitzers.
- Die Reihenfolge der mitgesendeten Attribute wird zu ihrer Anzeigereihenfolge. Wurde eine
Attributreihenfolge gespeichert (siehe unten), behalten die Systemattribute,
natural_idund verwaltete Rückseiten ihre Plätze, und die eigenen Attribute füllen die übrigen Plätze in der mitgesendeten Reihenfolge.
Schemaänderungen akzeptieren eine optionale lock_version auf oberster Ebene. Eine veraltete mitgesendete
Version liefert 409. Ohne Version wird die Änderung auf die aktuelle Version angewendet.
Attributreihenfolge
Die Liste attributes eines Objekts wird in Anzeigereihenfolge geliefert. Dieselbe Reihenfolge bestimmt
Datensatzformulare und die Spalten der erzeugten Standard-Listenansicht. Solange keine Reihenfolge
gespeichert ist, steht id an erster Stelle, gefolgt von den plattformverwalteten Attributen (etwa
natural_id und verwalteten Relationsrückseiten), dann den eigenen Attributen des Objekts; created_at,
updated_at und lock_version stehen am Ende.
updateObjectAttributeOrder
ersetzt die vollständige Reihenfolge, einschließlich der Systemattribute, natural_id und verwalteter
Rückseiten. Führen Sie jeden Slug aus attributes des Objekts genau einmal auf:
PUT /api/v2/definitions/objects/equipment/attribute-order
Content-Type: application/json
{"attribute_slugs":["name","created_at","updated_at","asset_tag","category","id","natural_id","lock_version"],"lock_version":3}
Ein fehlender, unbekannter oder doppelter Slug liefert 422 mit je einem Fehler pro Problem unter
#/attribute_slugs. Es ändert sich nur die Reihenfolge; Attributwerte und Datensätze bleiben unberührt.
Später hinzugefügte Attribute werden am Ende angefügt. Verwaltete Objekte lehnen den Request mit
409 schema-locked ab.
Lokalisierung
Geben Sie in name einen oder mehrere Sprach-Tags als Schlüssel an. Ein Tag besteht aus einem zwei-
oder dreibuchstabigen Sprachcode und kann eine vierbuchstabige Schrift sowie eine zweibuchstabige oder
dreistellige Region enthalten. Tourfold kanonisiert den Schlüssel beim Schreiben, zum Beispiel wird
SR-latn zu sr-Latn und pt-br zu pt-BR. Fehlerhafte Schlüssel oder mehrere Schlüssel, die auf
denselben Tag kanonisiert werden, liefern 422 validation-failed, statt stillschweigend verworfen zu
werden.
Clients lösen eine Bezeichnung in dieser Reihenfolge auf:
- Aktuelle UI-Sprache
- Standardsprache des Workspace
- Englisch (
en) - Eine beliebige vorhandene Übersetzung
Erstellung und Änderung verwenden dieselbe Map. Eine weitere Sprache kann daher später ohne eigene Übersetzungsoperation ergänzt werden. Die API liefert keine duplizierte, bereits aufgelöste Bezeichnung.
Verwaltete Objekte
Systemobjekte wie user und tour sowie pluginverwaltete Objekte können im selben Katalog erscheinen.
Ihre erstellten Schemata sind fest, einschließlich Bezeichnungen und Anzeigevorlagen. Schemaänderungen
und Löschversuche liefern 409 mit https://problems.tourfold.com/definitions/schema-locked. icon und
color sind Darstellung, kein Schema: Ein Metadaten-PATCH, der nur diese Felder ändert, ist
erfolgreich, und verwaltete Objekte werden mit einem Standard-Icon und einer Standardfarbe ausgeliefert.
PATCH /api/v2/definitions/objects/device
Content-Type: application/merge-patch+json
{"icon":"tablet-screen-button","color":"teal"}
Verwenden Sie schema_policy (editable oder locked), um Schemabearbeitung und Löschen
freizuschalten, und managed_by, um den Eigentümer zu erkennen. Für die Schreibbarkeit von Datensätzen
auf Definitionsebene verwenden Sie is_readonly; Berechtigungen des Aufrufers, Objekt-ACLs und
datensatzspezifische Einschränkungen gelten weiterhin.
Eine verwaltete Definition kann das Anlegen und Bearbeiten von Datensätzen erlauben. Codieren Sie keine
Liste verwalteter Slugs fest. Automatisch erzeugte Relationsrückseiten folgen ihrem Quellattribut und
berechtigen nicht dazu, das erstellte Schema des Ziels zu bearbeiten.
Der Objektkatalog wird aufsteigend nach slug paginiert, mit der unveränderlichen Objekt-id als
stabilem Tiebreaker. Das Blättern durch denselben unveränderten Katalog liefert daher bei jeder Anfrage
dieselben Seitengrenzen.
Beim Löschen eines Objekts werden auch seine Datensatztabelle, die von diesem Objekt besessenen
Relationen sowie gespeicherte Listen- und Detailansichten, deren Basis dieses Objekt ist, in derselben
Transaktion gelöscht. Besitzt ein anderes Objekt ein Relationsattribut, das auf dieses Objekt zeigt,
liefert der Löschversuch 409 mit
https://problems.tourfold.com/objects/relationship-target-in-use. Entfernen Sie zuerst das genannte
Eigentümerattribut. Dadurch verändert das Löschen eines Ziels niemals stillschweigend das Schema eines
anderen Objekts.