Fields¶

The fields of a model are the properties of its features, except its geometry field, whose value is their geometry.

Properties¶

Every field is served as a property, the primary key included, in the order the model declares them, unless the options of the collection choose others. The primary key is also the id of the feature, as a string. Reverse relations are not served.

The values are written as JSON:

Dates, times and durations are written as Django's DjangoJSONEncoder writes them.

Writing properties¶

A POST or a PUT takes the properties of a whole feature: those of the fields that have no default and cannot be null are required. A PATCH takes only the properties it changes.

Read-only fields are served, but not written: the fields of files, generated fields, and those listed in readonly_fields. A write that carries a read-only field, or a property that the collection does not have, is rejected with a 422 Unprocessable Content, as is a write with an invalid value. A client that writes back a feature it has read has to leave out its read-only properties.

The primary key of a POST is the one of the feature created, and defaults as the model defines it. A POST with the key of an existing feature is rejected with a 409 Conflict. PUT and PATCH ignore the key: they always change the feature of the URL.

Schema¶

/collections/{collectionId}/schema returns the JSON Schema of the features of a collection, as defined by OGC API - Features - Part 5: the type and format of each property, its bounds, length, pattern and choices, its position, the required and read-only ones, the primary key, with the id role, and the geometry, with the primary-geometry role and its type as format:

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://example.com/oapif/collections/my_app.building/schema",
  "title": "my_app.Building",
  "type": "object",
  "properties": {
    "id": {
      "title": "ID",
      "type": "integer",
      "x-ogc-role": "id",
      "minimum": -9223372036854775808,
      "maximum": 9223372036854775807,
      "x-ogc-propertySeq": 1
    },
    "name": {"title": "Name", "type": "string", "maxLength": 100, "x-ogc-propertySeq": 2},
    "geom": {"title": "geometry", "x-ogc-role": "primary-geometry", "format": "geometry-polygon", "x-ogc-propertySeq": 3}
  },
  "required": ["name"],
  "additionalProperties": false
}

A foreign key has the reference role, see foreign keys.