GET /schema/<Type>/fields

Params

Sample requests

r = c.get("/schema/Version/fields")

Keyed by programmatic field name. On the probed site, Version has 71 fields in 47958 bytes:

{
  "data": {
    "code": {
      "name":        { "value": "Version Name", "editable": true },
      "entity_type": { "value": "Version",      "editable": false },
      "data_type":   { "value": "text",         "editable": false },
      "editable":    { "value": true,           "editable": false },
      "mandatory":   { "value": true,           "editable": false },
      "unique":      { "value": false,          "editable": false },
      "properties":  { "default_value": { "value": null, "editable": false } }
    }
  }
}

Which fields a client may write:

f = c.get("/schema/Version/fields").json()["data"]
print([k for k, v in f.items() if v["editable"]["value"]])

Response codes

Edge cases

• mandatory is not the create contract. code reads mandatory: true and a create omitting it succeeds at 201 with a server-invented name; project reads mandatory: false and a create omitting it is 400. Read the create contract from the entity-type card, not from this flag.
• Every value is wrapped in {value, editable}, and the outer editable says whether you may change the property, not whether you may write the field. data["code"]["editable"]["value"] is the one that answers "can I write this".
• Adding project_id changes the body by 28 bytes on the probed site: only hidden_values appears. Everything else is identical at every scope.
• 48KB and about 330ms per type. Never loop this over the /schema listing.