DELETE /schema/<Type>/fields/<field>
delete_schema_type_fields_field
Retires a field at 204 and burns its programmatic name forever: the same name will not create again, only revive. Treat this as irreversible from REST.
API
Params
| part | value |
|---|---|
<field> |
the programmatic name |
Sample requests
r = c.delete("/schema/Version/fields/sg_my_field")
print(r.status_code, repr(r.text))
# 204 ''
What changed, in order:
c.get("/schema/Version/fields/sg_my_field").status_code # 404
"sg_my_field" in c.get("/schema/Version/fields").json()["data"] # False
Creating the same display name again:
{"errors": [{"status": 400, "code": 103,
"title": "API schema_field_create() failed, there is a retired field with the same field_name: sg_my_field. Delete the retired field forever from the Trash Page in Shotgun and try again."}]}
Response codes
| status | when |
|---|---|
| 204 | retired, empty body |
| 400 | code 104 User doesn't have permission to retire a Field for an Artist (probe 132) |
| 404 | code 103 Field '<Type>.<field>' does not exist., for a retired field or an unused name, checked before permission |
Edge cases
- A link field is one link with two names. Retiring the reverse field an entity or multi_entity field made on its linked type retires the forward field too, and the reverse goes with the forward (probe 142).
- The name is not freed. The error tells you to empty the Trash page in the web interface, which
REST cannot do. From an API client the only way back is
POST /schema/<Type>/fields/<field>with{"revive": true}, and it returns at the original type. - The collision is on the programmatic name alone. Recreating at a different
data_typeis the identical 400. - A probe cannot clean up after itself here the way it can for a row. Test on a stock field, and where
one has to be created, name it
sg_zzprobe_<nnn>_*so it is identifiable when the Trash page is emptied.