Begriffe

Ein paar Erklärungen zu Begriffen, die wir auf unseren APIs verwenden.

Allgemeine Attribute

ETag

optional
type: string (11 characters)
example: SdfAzcfsdcf
Ein Hash auf das Objekt.

Der ETag (entity tag) wird üblicherweise im Header Feld verwendet und dient zur Bestimmung von Änderungen der angeforderten Resource. Anhand des ETags kann effizient entschieden werden, ob sich die Inhalte (die Daten) geändert haben. Ist der ETag unterschiedlich zur lokalen Kopie, dann sollte die Ressource erneut synchronisiert werden.

An ETag is an opaque identifier assigned by a Web server to a specific version of a resource found at a URL. If the resource representation at that URL ever changes, a new and different ETag is assigned. Used in this manner, ETags are similar to fingerprints and can quickly be compared to determine whether two representations of a resource are the same.

created_at

mandatory
type: datetime
example: 2022-09-27 20:12:36.879+00:00
Zeitpunkt der Erstellung des Objektes.

modified_at

mandatory
type: datetime
example: 2022-09-27 20:12:36.879+00:00
Zeitpunkt der letzten Änderung des Objektes.