GET /schema/<Type>/fields/<field>

Params

Sample requests

Site scope:

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

{
  "data": {
    "name":       { "value": "Status",       "editable": true },
    "data_type":  { "value": "status_list",  "editable": false },
    "editable":   { "value": true,           "editable": false },
    "mandatory":  { "value": false,          "editable": false },
    "properties": { "default_value": { "value": "rev", "editable": true } }
  }
}

Project scope, which is the only call that answers "which statuses may I use here":

PROJECT = 70
p = c.get("/schema/Version/fields/sg_status_list",
          params={"project_id": PROJECT}).json()["data"]["properties"]
print([v for v in p["valid_values"]["value"] if v not in p["hidden_values"]["value"]])

On the probed site and project: 16 valid_values, hidden_values ['pndl', 'pndvs'], so 14 usable.

Response codes

Edge cases

• Without project_id, hidden_values is empty and the same 16 come back. A picker built on the site-scope answer offers statuses the project's own interface refuses.
• REST does not enforce the subtraction on write. A hidden status writes and reads back fine, so every client subtracts hidden_values itself.
• The 404 names the type and the field together, Version.sg_not_a_field, which is the only error on the schema endpoints that says which half you got wrong.
• A 200 with data: null is a third answer, not an empty one. Note.read_by_current_user is on every Note, filters and takes a write, and is in neither GET /schema/Note/fields nor this call's data. Ask this endpoint, not the field census, before concluding a field is absent (probe 068).