SG Ground Truth

Endpoints — Schema, POST

Every call in this family: what the card records, the edge cases that live on the call, and the verdict of every entry that measured it. Each of those lines names the door holding that entry's rules. The map is corpus/INDEX.md.

API

POST /schema/<Type>/fields

You send a display name and the server derives the sg_ name, which is only in links.self. A duplicate display name is 201 with a silent _1 suffix, so read /fields first.

Display name to programmatic name, measured:

display name sent name created
zzprobe 019 With (Parens) sg_zzprobe_019_with__parens_
sg_zzprobe_019_already_prefixed sg_sg_zzprobe_019_already_prefixed, prefixed twice
a name already in use <name>_1, at 201, with no warning
zzprobe 117 a--b..c!!d e_f sg_zzprobe_117_a__b__c__d__e_f: one _ per character, runs kept
zzprobe 117 spaces sg___zzprobe_117_spaces__, not trimmed
120 ASCII characters 123, uncut
any name holding a non-ASCII character, on currency sg_currency: the display name is discarded (probe 117)
  • Deleting a field does not free its name. DELETE retires the field and the name stays taken, released only by emptying the Trash page in the web interface. An ensure() reads /fields first rather than posting and hoping, and a field created to test with is named sg_zzprobe_<nnn>_* so whoever empties that page can tell litter from a real field.

  • number takes 2147483647 and 400s on 2**63, so a 64-bit id or seed does not fit one.

Measured by

  • 019_create_fields (findings) — Custom fields are creatable over REST, but you pass a display name and a duplicate silently becomes _1: an idempotent ensure() must read /schema first, never POST-and-hope.
    rules: doors/findings-schema
  • 040_field_revive (findings) — A trashed field is revived by POST /schema//fields/ with {"revive": true} at 204, but it returns at its original data_type, and a PUT changing data_type is a 200 that does nothing.
    rules: doors/findings-schema
  • 116_field_settings_create_update (findings) — A create takes description, unique, valid_values, default_value and valid_types. unique and a multi_entity's valid_types never change afterwards; an entity's valid_types and list values do.
    rules: doors/findings-schema
  • 117_field_types_and_names (findings) — One non-ASCII character in the display name and the field is named sg_<data_type>, at 201. ASCII names are lowercased, every other character becomes _, nothing is trimmed or cut.
    rules: doors/findings-schema
  • 118_field_writes_other_types (findings) — Create, update, per-project visible, retire, the retired-name 400 and revive answer on a custom entity and on Tag, which has no project field, exactly as on Version.
    rules: doors/findings-schema
  • 119_field_absent_retired_live (findings) — Revive is 204 only on a retired field: 404 Retired field ... does not exist. on an unused name, 400 ... is not retired. on a live one. A retired field is a 404 to GET, PUT and DELETE.
    rules: doors/findings-schema
  • 132_field_create_rights (findings) — An Artist creating a field gets 500 code 105 User doesn't have permission to create a Field, with a traceback. An Admin person gets 201. Treat any 500 from a schema write as a possible refusal.
    rules: doors/findings-schema
  • 142_reverse_field (findings) — Every entity or multi_entity field makes a visible, editable multi_entity on each linked type. No create property stops it, and DELETE of the reverse field retires the forward field too.
    rules: doors/findings-schema
  • 157_project_custom_field (findings) — An Admin person creates a text field on Project with name and description at 201; it reads back like a field on any type. An Artist gets 500 code 105 User doesn't have permission to create a Field.
    rules: doors/findings-schema
  • 160_jsonb_field_create (findings) — A jsonb or serializable field cannot be created over REST, on Project or any type tried: 400 code 103 data_type is not valid. Store JSON in a text field and parse it.
    rules: doors/findings-schema
  • 167_rollup_on_shot (findings) — A query (summary) field cannot be created over REST: 400 data_type is not valid, with or without a query. Total each Shot's Bid Lines with one _summarize grouped on the link.
    rules: doors/findings-filter
  • 127_retry_and_client_uuid (findings) — A text field created with unique: true refuses a second create with the same value, case and outer spaces ignored, in a batch too. It is the only idempotency key: the API has no header for it.
    rules: doors/findings-write
  • 136_unique_scope_retired (findings) — A deleted row frees its unique value: a new row may take it. Reviving the old row while another holds the value is a 400 code 104 PG transaction error, and the row stays retired.
    rules: doors/findings-write
  • 137_batch_create_coercion (findings) — A _batch create on a custom entity takes a numeric string in a float and honours created_at, as a single POST does. It also takes an Integer and "1e3", which a single POST refuses.
    rules: doors/findings-write
  • 145_time_fields (findings) — date_time rounds to the second on POST and PUT (.999 goes up, .5 stays) but truncates in a _batch create. A new timecode field has no rate property; it is integer ms rendered at the site's fixed rate.
    rules: doors/findings-write
  • 146_note_unique_key (findings) — A unique: true text field works on Note as on Version (probe 127), and refuses a duplicate on PUT and under sudo too. A Note.meta key is found by contains, case-sensitive, and enforces nothing.
    rules: doors/findings-write
  • 158_project_text_size (findings) — A custom text field on Project stored 1,000,000 characters of JSON byte for byte, \n, \r\n and tabs kept, with no refusal. Leading and trailing whitespace is stripped.
    rules: doors/findings-write
  • 123_photos_per_record (findings) — image keeps only a 480x320 thumbnail. A url field holds one original, a Note's attachments or a multi_entity to Attachment hold many; all return the bytes unchanged.
    rules: doors/findings-upload
  • 134_attachment_field_second_upload (findings) — A second _upload to a multi_entity field to Attachment adds: the field holds both. Each Attachment gets the row's project and the row in attachment_links, so a project filter finds it.
    rules: doors/findings-upload
  • 135_attachment_custom_field_filename (findings) — Attachment takes a custom field over REST. filename keeps 90 and 200 characters but stores each space as _; is and starts_with ignore case, so filter on the name with _ for spaces.
    rules: doors/findings-upload
  • 025_retry_safe_create (recipes) — Create rows from a client that retries after timeouts, without duplicating any row
    rules: doors/recipes
  • 028_settings_on_project (recipes) — Keep an app's settings for a project as JSON on the Project row, written by an Admin and read by everyone in the project
    rules: doors/recipes
  • 006_duplicate_field_name_is_201 (reports) — Creating a custom field whose display name is taken answers 201 for a suffixed field instead of a conflict, and every retry burns a programmatic name no REST call frees.
    rules: doors/reports

Silent on this call

  • post_schema_type_fields — You send a display name and the server derives the sg_ name, which is only in links.self. A duplicate display name is 201 with a silent _1 suffix, so read /fields first.
  • 019_create_fields — Custom fields are creatable over REST, but you pass a display name and a duplicate silently becomes _1: an idempotent ensure() must read /schema first, never POST-and-hope.
  • 040_field_revive — A trashed field is revived by POST /schema//fields/ with {"revive": true} at 204, but it returns at its original data_type, and a PUT changing data_type is a 200 that does nothing.
  • 117_field_types_and_names — One non-ASCII character in the display name and the field is named sg_<data_type>, at 201. ASCII names are lowercased, every other character becomes _, nothing is trimmed or cut.

corpus/endpoints/post_schema_type_fields.md

POST /schema/<Type>/fields/<field>

Revive a retired field, at 204. It is the only way to get a burnt name back, and it returns at its original data_type whatever the site wants now.

  • The revived field keeps its original data_type. A name burnt as text cannot come back as number, and the PUT that would change it is a 200 that does nothing.

  • The API named this parameter itself, in the 400 for an empty body. /spec.json documents the call as of 2026-11-10, with revive as a query parameter. The published reference does not.

  • The field returns as it was retired: display name, description, default and valid values. Its per-project visible does not: a field hidden in a project came back visible there (probe 115).

  • It has no opposite. {"revive": false} and every delete-forever spelling tried are refused, so a trashed name is freed only from the Trash page in the web interface (probe 114).

Measured by

  • 040_field_revive (findings) — A trashed field is revived by POST /schema//fields/ with {"revive": true} at 204, but it returns at its original data_type, and a PUT changing data_type is a 200 that does nothing.
    rules: doors/findings-schema
  • 114_schema_admin_recheck (findings) — On 2026-11-10 /spec.json names calls to enable, disable and configure a custom entity, all 400 code 111 on the probed site. No call deletes a trashed field forever or writes hidden_values.
    rules: doors/findings-schema
  • 115_field_visibility_per_project (findings) — visible is per project. Read it with ?project_id=N; write it with PUT and project_id in the body or the query, never without one. A new field is visible in every project.
    rules: doors/findings-schema
  • 117_field_types_and_names (findings) — One non-ASCII character in the display name and the field is named sg_<data_type>, at 201. ASCII names are lowercased, every other character becomes _, nothing is trimmed or cut.
    rules: doors/findings-schema
  • 118_field_writes_other_types (findings) — Create, update, per-project visible, retire, the retired-name 400 and revive answer on a custom entity and on Tag, which has no project field, exactly as on Version.
    rules: doors/findings-schema
  • 119_field_absent_retired_live (findings) — Revive is 204 only on a retired field: 404 Retired field ... does not exist. on an unused name, 400 ... is not retired. on a live one. A retired field is a 404 to GET, PUT and DELETE.
    rules: doors/findings-schema
  • 121_field_settings_edges (findings) — A PUT applies all its properties or none, in any order. A description or name cannot be emptied. valid_types keeps the sent order, and a lowercase type name is a 500 that retires the field.
    rules: doors/findings-schema
  • 132_field_create_rights (findings) — An Artist creating a field gets 500 code 105 User doesn't have permission to create a Field, with a traceback. An Admin person gets 201. Treat any 500 from a schema write as a possible refusal.
    rules: doors/findings-schema
  • 158_project_text_size (findings) — A custom text field on Project stored 1,000,000 characters of JSON byte for byte, \n, \r\n and tabs kept, with no refusal. Leading and trailing whitespace is stripped.
    rules: doors/findings-write
  • 028_settings_on_project (recipes) — Keep an app's settings for a project as JSON on the Project row, written by an Admin and read by everyone in the project
    rules: doors/recipes

Silent on this call

  • 040_field_revive — A trashed field is revived by POST /schema//fields/ with {"revive": true} at 204, but it returns at its original data_type, and a PUT changing data_type is a 200 that does nothing.
  • 117_field_types_and_names — One non-ASCII character in the display name and the field is named sg_<data_type>, at 201. ASCII names are lowercased, every other character becomes _, nothing is trimmed or cut.

corpus/endpoints/post_schema_type_fields_field.md

Every entry on this site is the output of a probe in probes/. The corpus is generated by running those probes against a live Flow Production Tracking site, not written from memory.

Not affiliated with or endorsed by Autodesk. Flow Production Tracking is their product; this is an independent record of how its REST API answers.