Findings — schema: what the site has, and adding to it
How the API behaves in this part of a session. Each rule is the entry's own Teaches, copied whole.
002_schema
Fetch /schema once for the type list, then /schema/
- A connection type's REST slug collapses the doubled underscore.
Asset_linked_projects_Connectionis addressable as itself or asasset_linked_projects_connections, while the naive snake_case rule givesasset_linked_projects__connections, which 404s. Ten types on the probed site are affected (recipes/003).
Sizes below are from the probed site.
| call | size | what it gives |
|---|---|---|
/schema |
13KB | the type list, nothing per type |
/schema/<Type> |
138b | name and visible |
/schema/<Type>/fields |
48KB | every field on the type |
/schema/<Type>/fields/<field> |
1.2KB | one field, when you know its name |
/schema/entity_types |
404 "Not Found" |
no lighter enumeration exists |
/entity_types, /entity, /api/v1/entity |
404, detail: null |
not routes |
/schema/<x>addresses one entity type, so an enumeration path under it is read as a type name and 404s saying so:entity_types,entity_type,entities,typesand_typeseach returnEntity type '<x>' does not exist.Off that prefix,/entity_types,/entityand/api/v1/entity404 withdetail: null./schemais the type list; there is nothing lighter.There is no cheap middle tier: anything about a type costs the
/fieldscall, so drill straight to one field with/fields/<field>when you know the name.project_idis accepted on both/schemaand/fieldsand does change the body (13368 → 13395b, 48111 → 48139b), so a project-scoped schema is not the site schema. Cache the two under separate keys (see the.schema-cache/<site>/<site|pNNN>/split).Site settings are not under
/schema.GET /preferencesreturns 200 with 17 keys,hours_per_dayandduration_unitsamong them (field_types/duration).Nothing in a field's block names where the field came from.
visible.editableis the closest reading and thesg_prefix is not one at all (probe 056).Counts are site state, not API constants. On the probed site,
/schemareturned 114 types andVersion71 fields, against 113 and 61 on an earlier run. Measure and cache; never hardcode a count or a field list.
corpus/findings/002_schema.md
008_custom_entities
Presence in /schema is the enablement test for a custom entity: a slot absent from the listing 404s. Slot numbers are non-contiguous and site-specific, so read name.value and never hardcode one.
Presence in /schema is the enablement test, in both directions. A slot in the listing is enabled, and a slot absent from it is unaddressable:
GET /schema/CustomEntity08andGET /schema/CustomEntity08/fieldsboth return 404Entity type 'CustomEntity08' does not exist.Enumerate/schemarather than probing slot numbers.On the probed site every slot in
/schemareadvisible: true, sovisible: falsewas never observed. Treat absence, notvisible, as the disabled signal. A site with a slot enabled and then disabled would settle whethervisiblecan read False.Never hardcode a slot number: they are non-contiguous and site-specific. On the probed site the enabled slots are 01-07, 19, 29 and 66. Look a slot up by its
name.valuedisplay name.A connection entity is its own type,
CustomEntity29_sg_scene_Connection, and its display name is machine-derived from the type name rather than studio-chosen.Display names are free text and may include a trailing space (
CustomEntity66above), so match them trimmed.
corpus/findings/008_custom_entities.md
009_status_lists
A project's usable statuses are valid_values minus hidden_values, read with project_id: valid_values is identical at every scope, hidden_values is the only thing that varies.
Usable statuses are
valid_valuesminushidden_values, read withproject_id. REST does not enforcehidden_valueson write, so do the subtraction yourself. Seefield_types/status_list.md.valid_valuesis the site's whole vocabulary and is byte-identical at every scope, so reading it alone tells you nothing about a project. On the probed site, 21 scopes returned 1 distinct value.hidden_valuesis the only thingproject_idchanges. Omitproject_idand you get the site-wide answer, which hides nothing and will offer statuses the project's UI refuses.Status lists are per entity type. On the probed site, Version and Task overlap only on
ip/fin/apr/na/rev, and Task'swtg/hld/omt/readydo not exist on Version. Never reuse one type's codes for another.On the probed site, Version's 16
valid_valuesleave 10 usable in one project, 14 in another and 15 in a third, and 15 of the 21 projects hide the same 6 codes. Which codes a project hides is site configuration, not API behaviour: read it per project rather than reusing a list between sites.Always render
display_values:pndvsmeans "Pending VFX Supervisor" to nobody, and a missing key there is possible, so fall back to the raw code rather than dropping the option.
corpus/findings/009_status_lists.md
019_create_fields
Custom fields are creatable over REST, but you pass a display name and a duplicate silently becomes
Trap. A duplicate display name does not error: it creates
<name>_1, and it keeps going. Three creates of one display name gavesg_zzprobe_041_dup,sg_zzprobe_041_dup_1andsg_zzprobe_041_dup_2, all at 201, all three live at once and all three reading back the identical display name.A display name identifies nothing, so a client that looks a field up by the name a person typed can match several fields or the wrong one. Match on the programmatic name. An idempotent
ensure()must GET/schema/Version/fieldsand match first, never POST-and-hope.Trap.
DELETEreturns 204 and the field vanishes from/schema, but the name is not freed: re-creating it 400s, and the trashed field cannot be enumerated, so the collision is invisible.That is one delete-and-recreate cycle on one field name, observed once; settling whether every deleted name behaves this way costs another name, which this repo does not spend. Treat a name you have created as spent.
On the probed site Version has 71 fields against the 61 of
probe 002, and the ninesg_ai_*fields are the difference; none follow thesg_zzprobe_<nnn>_*conventiondocs/quirks.mdmandates. Attribution of those nine to this probe is<unverified>: the committed code createszzprobe 019 *names, and no creator is recorded anywhere.You pass a display name and the
sg_prefix is added for you, sosg_foobecomessg_sg_foo. The programmatic name is absent from the response body; take the last segment oflinks.self.Most creation 400s are a missing
properties, not a refusal. Onlycolor,imageandcalculatedare rejected outright;entityandmulti_entityneedvalid_typesholding exactly one type, andcheckboxneedsdefault_value.multi_entityround-trips lineage underrelationships(field_types/multi_entity).A seed must be a text field:
numberis signed 32-bit, and 64-bit ids and seeds reach 2**64-1 (field_types/number).
corpus/findings/019_create_fields.md
040_field_revive
A trashed field is revived by POST /schema/
| do | why |
|---|---|
| Read the schema and match before creating | a trashed name is unlistable, so the collision is unpredictable otherwise |
Revive with POST <field path> and {"revive": true} |
it is a 204 and it is in no documentation |
Read data_type back after reviving |
it returns at its original type, whatever you asked for |
Never trust a PUT that changes data_type |
the top-level form is a 200 that does nothing |
| Give up on the name when the type is wrong | nothing converts a trashed field to another type |
| Never create a field to test with | the name is spent whether you trash it, revive it or re-trash it |
The quiet neighbour is worse still. A duplicate of a live field does not error: it silently becomes
<name>_1 (probe 019). A create returns 201 both when it did what you meant and when your code now
writes to a field that is not the one you asked for.
corpus/findings/040_field_revive.md
042_spec_coverage
GET /spec.json returns the deployment's own OpenAPI v3 document. It advertises 62 operations against the 23 this corpus covers, and it disagrees with the published documentation.
The deployment answering your calls will hand you its own endpoint list. Reconstructing one from documentation is unnecessary and, here, wrong.
The spec and the published reference disagree. The reference documents
PUT /entity/{entity}/{record_id}/_revive,POST .../_upload_complete,PATCH /schema/{entity}/fields/{field}andPATCH /preferences.This site's spec has none of those spellings, and has
PUT /schema/<type>/fields/<field>andPUT /preferences/updateinstead. Probe 041 measured thePUTon a schema field working. Read the spec, not the reference.servers[0].urlends in/api/v1.1. Every recorded call in this corpus was made against/api/v1. Probe 051 swept 20 read-only calls under both prefixes: the two are the same API, differing only inapi_versionin the root document and the prefix each echoes in its ownlinks.The two upload steps with no operation in the spec are correct as they stand:
links.uploadis a presigned storage URL and is not a route on this API at all.The document changes without notice. On 2026-11-10 the same call returned 49 paths and 68 operations: three under
/preferences/custom_entity(probe 114) and three under/schema/permission_groups, none of them in a release note.191KB is too large to hand an agent.
probes/042_spec_coverage.pyprints the difference between the spec andcorpus/endpoints/, which is the only part that changes.
corpus/findings/042_spec_coverage.md
047_site_facts_and_the_working_week
Three site-fact calls, three different envelopes: {data, status}, a bare hash, and JSON:API. Only /schedule/work_day_rules reports a bad scope id, and it reports it as a 200.
Every site-fact call has its own envelope.
/license_inforeturns{data, status}with nolinks, the subscription hash returns neither, and only/schedule/work_day_rulesis JSON:API. One decoder does not read all three.A
project_idoruser_idthat does not exist is a 200, not a 404. The studio default answers instead, andreasonreadsSTUDIO_WORK_WEEKfor both the fallback and a real studio-wide answer. A client asking "is this a working day for project X" gets a plausible answer for a project that is not there. Check the id first.One endpoint, two error shapes. A missing or out-of-order parameter is a JSON:API
errorsarray; an unparseable date is{"status": "error", "error": "invalid date"}with noerrorskey.r.json()["errors"][0]raises on the second.No paging on
work_day_rules: a 730-day window returned 730 rows in one 61631-byte response, with nopageenvelope and nolinks.next. Bound the range in the request.PUT /preferences/updaterefused every body identically on the probed site,{}and a complete one alike, so the 400 tells a client nothing about its own payload and the parameter names in/spec.jsonstay unverified. The code is 111 andsourceisnull, not the 103 with a populatedsourcethat parameter errors use elsewhere.The three ways to count users disagree. On the probed site
license_info.assignedwas 4, the subscription hash held 14 keys and there were 24 HumanUser rows, andsg_status_listdid not predict which users the hash held. Do not derive a seat count from a user query.POST /subscription_seat/user_subscriptionswith{}answers 200 with{}: a 200 that assigned nothing looks exactly like one that assigned something. Its per-user failures are a 207 whose messages are strings inside the hash, whichr.okpasses over.The write paths for the working week, subscriptions and custom entity slots were exercised only with bodies that must fail. Each of the three changes configuration for every user of the site, and none has a dry run.
corpus/findings/047_site_facts_and_the_working_week.md
056_stock_vs_custom_field
A field with visible.editable false is stock and safe to depend on; true means the site can hide it, which is every custom field and a few stock ones. The sg_ prefix decides nothing.
visible.editableis the flag, and it reads one way round.falsemeans the site cannot hide the field, and no custom field on the probed site readfalse.trueis "the site may hide this", which every custom field is and a few stock fields are as well, so it is a strong hint and not a proof.The
sg_prefix decides nothing in either direction. On the probed site 126 of 439 fields are named with it and 33 of those are stock,sg_status_listand the wholesg_uploaded_moviefamily among them. Probe 019 explains the other half: a field created over REST is namedsg_<display name>whatever the caller passes, so the prefix marks how a field was named, not who added it.On the probed site 4 of 97
visible.editablefields are not prefixed.version_sg_ai_generated_from_versionsis the reverse side of a custommulti_entityfield, so it is custom under a generated name.Project.codeandplatform_statuson Version and Shot are stock. Readingvisible.editableas "custom" would have called all four wrong.Nothing in the schema names the origin of a field.
custom_metadatais""on all 439, andvisible.valueistrueon all 439, so neither separates anything. A client that needs certainty reads/schema/<Type>/fieldson the site it is about to write to and matches on the programmatic name (probe 002), rather than deciding from a name it learned somewhere else.
corpus/findings/056_stock_vs_custom_field.md
061_shipped_statuses
Nothing in the schema marks a shipped Status. system is true on a minority of them; the stock set is created_by is null, plus options[return_only]=retired for the rows a site retired.
created_by is nullselects the shipped rows and is the only mark that does. It is one filter at 200, so the split costs no extra call. A row an operator added names them increated_by, andcreated_byiseditable: false, so nobody can blank it afterwards.systemis a checkbox whose display name isLocked by System, and it does not mean "shipped":selection on the probed site created_by is null19 rows system is true6 rows, actdisipnacfrmpndngsystem is trueandcreated_byset0 rows an orof the two19 rows, the same set as created_by is nullalonesystemis a subset, so anoradds nothing andsystemalone drops 13 shipped codes.created_atis not a mark either. On the probed site it is null on 17 of the 19 shipped rows and2014-08-06oncfrmandpndng, which no creator names, while every operator-added row from id 32 up has both a date and a person.The live listing is what the site kept, not what it started with. On the probed site 9 further rows are retired, 8 of them with no
created_by(cbb,rdy,blk,plsh,late,rsk,rrq,out), and onlyoptions[return_only]=retiredreturns them. A low id proves nothing on its own: retired id 20,tkt, names a person.The 19 shipped codes on the probed site, with the stock
image_map_keyeach points at. Resolve a key against the site's own stylesheet and the/images/sg_icon_image_map.pngsprite, both of which answer an unauthenticated GET at 200; probe 010 andrecipes/010_status_pickerrecord that rediscovery and the offsets.code name image_map_keyactActive none. On the probed site it points at a custom_status/htmliconaprApproved icon_aprclsdClosed icon_fincmptComplete icon_cmptdisDisabled icon_nafinFinal icon_finhldOn Hold icon_hldipIn Progress icon_ipnaN/A icon_naomtOmit icon_omtopnOpen icon_rdyresResolved icon_finrevPending Review icon_revwtgWaiting to Start icon_wtgvwdViewed icon_finrecdReceived icon_recddlvrDelivered icon_dlvrcfrmConfirmed icon_thumb_uppndngPending icon_voice_command15 distinct keys over 19 codes:
icon_findrawsclsd,fin,resandvwd, andicon_nadrawsdisandna. The icon does not identify the status, andiconis the one editable field on the row, so a stock code can point at a custom icon.Which codes a site holds is site configuration, and only the shape transfers. Read the split per site rather than hardcoding the 19: this site retired 8 shipped rows and added 13 of its own, and a shipped code is still only offered where a type's
valid_valueslists it (probe 009).
corpus/findings/061_shipped_statuses.md
091_status_summary_exclusions
Excluded statuses are invisible to REST: not in /schema at any scope, not writable by PUT. status_list honours them: fin plus an excluded omt rolls up to fin, omt alone to na. [partial]
not measured: status_list with the exclusion removed on the same rows: the setting is not API-writable, so the before state rests on probe 079's rule, not on a toggle. Blocked on the API.
The setting is stored where REST cannot read it. It is
status_list_summary_excludeinside the field'sDisplayColumndata_type_properties, and DisplayColumn is not a REST type. It is site-wide: the change event names no project, and the schema reads the same with and withoutproject_id.The one REST trace is
Shotgun_DisplayColumn_Changein the event log, whosemeta.new_valueholds the list. A client can learn the current list only from the newest such event, if the log still has it.Not writable.
PUT /schemarejects the name and enumerates the seven writable properties, so the exclusion is set in the web interface only (Fields, the status field, Summary = Status, Excluded statuses).status_listapplies it. Without an exclusion a mix rolls up toip(probe 079:[fin, wtg]givesip); withomtexcluded,[fin, omt]givesfin, andomtalone givesna, notomt. A client computing its own roll-up from grouped counts must drop the excluded statuses itself, and has to be told which they are.status_percentagereturned 0 on every set here and is not a share of anything (probe 079).
corpus/findings/091_status_summary_exclusions.md
114_schema_admin_recheck
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. [partial]
not measured: a custom entity call that succeeds. The probed site answers 400 code 111 to all three, so the bodies and responses in /spec.json are unverified. Blocked on the site.
| do | why |
|---|---|
Read /spec.json after a release |
it named three calls that no release note or reference page mentioned |
| Treat 400 code 111 from a custom entity call as "not available on this site" | it precedes validation, so it says nothing about the body or the slot |
| Keep sending users to the web interface to enable a slot or empty the field trash | neither can be done over REST on the probed site |
Send revive in the query or in the body |
both are a 204 |
Do not write hidden_values |
the update lists its seven valid property names and it is not one |
corpus/findings/114_schema_admin_recheck.md
115_field_visibility_per_project
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.
| do | why |
|---|---|
| Read one type's visibility per project with one listing call | ?project_id=N returns visible for all its fields |
| Treat a new field as visible everywhere | it reads true at site scope and in both projects straight after the create |
Send project_id with every visible write |
without it the write is a 400, and there is no site-wide write |
| Check the project id yourself before a read | a wrong id reads as "everything visible" at 200; only the write refuses it |
| Write visibility again after a revive | a field hidden in a project, retired and revived, came back visible there |
Do not use visible to protect data |
the hidden field was still returned by GET /entity/versions?fields= in that project |
Probes 118 and 119 repeat the write on a custom entity type and on Tag, which has no project field:
the same.
corpus/findings/115_field_visibility_per_project.md
116_field_settings_create_update
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.
| do | why |
|---|---|
| Send every setting in the create | all of them are accepted there, and unique and a multi_entity's valid_types are accepted nowhere else |
Read <setting>.editable before planning an update |
unique reads false on every field and valid_types reads false on a multi_entity: both are the refused ones |
Give a status_list its valid_values |
a bare create is a 400 |
| Send booleans as booleans | a checkbox default of "false" is stored as a string |
| Remove a list's default before removing its value | a list keeps a default that is no longer a valid value |
| Do not plan to clear a default | null and "" are both refused |
Send valid_values and default_value in one PUT when both change |
one request is checked as a whole and applied as a whole (probe 121) |
Probe 019 recorded "two types refused" without the link type. It was multi_entity: an entity field
takes several.
corpus/findings/116_field_settings_create_update.md
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. [partial]
not measured: a non-ASCII display name on a data type other than currency. Not sent: it would spend sg_
| do | why |
|---|---|
| Refuse a non-ASCII display name at creation, or create under an ASCII name and rename | the create succeeds under sg_<data_type>, and the rename leaves the programmatic name alone (probe 116) |
Read the name from links.self and compare it with the one you predicted |
a 201 does not mean the name you expected |
| Predict ASCII names with the one-line rule | it held for punctuation, digits, outer spaces, case and 120 characters |
| Expect a revive to return the field as it was retired | the rename, the default, the values and summary_default all came back |
sg_currency on Version was spent by this probe and is in the trash under the display name
zzprobe 117 Durée Écran ñ.
corpus/findings/117_field_types_and_names.md
118_field_writes_other_types
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. [partial]
not measured: a CustomNonProjectEntityNN. None is enabled on the probed site. Blocked on the site.
The same programmatic name,
sg_zzprobe_118_other_type, was created on both types: a name is taken per entity type, not per site.links.selfspells the type in snake case,custom_entityNNandtag, where Version's readsVersion. Take the last segment for the field name and do not parse the type out of it.Per-project
visibleworks on a type that has noprojectfield. Hiding the Tag field in the sandbox left the site scope and the sample project reading true.On the probed site the custom entity is project-scoped and Tag is stock. A
CustomNonProjectEntityNNwas not available to measure.
corpus/findings/118_field_writes_other_types.md
119_field_absent_retired_live
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. [partial]
not measured: a schema write by a person below Admin, and the permission groups as anyone but the script. Both need that person's session; none was available. Blocked on the site.
| do | why |
|---|---|
Treat a revive 404 as "nothing to revive" and a 400 is not retired as "already live" |
a 204 was only ever returned for a retired field, and the live field was unchanged |
Detect a retired name from source.field_name on a 400 code 105 |
no read distinguishes retired from unused |
| Treat a 404 on an update as "gone", retired or never there | the two are the same response |
Do not look in /schema/permission_groups for the right to change the schema |
it describes rows and field values |
corpus/findings/119_field_absent_retired_live.md
120_field_trash_page
The page that lists retired fields is a Page row: ui_category "trash", entity_type "DisplayColumn", named "Trash - Fields". Its id is per site, so search for it. [partial]
not measured: the web address itself. /page/<id> is the web interface's scheme, not a REST call, and it was not opened. Blocked on the work: it needs a browser session.
On the probed site there is one trash page per entity type that has been trashed from, each a site-level
Pagerow with no project. The one for fields hasentity_typeDisplayColumn, the type a field's own row has in the event log (Shotgun_DisplayColumn_Retirement).Find it with
filters: [["ui_category", "is", "trash"], ["entity_type", "is", "DisplayColumn"]]. The id differs per site. All 20 rows were created by a person, so a site where nobody has opened the field trash may have no row: handle zero results by describing the menu path in words.The address is
<site>/page/<id>. That is the web interface's scheme for aPagerow and is inferred here, not measured: no REST call opens a page.DisplayColumnis not reachable over REST as a type, so the retired fields themselves stay unlistable (probe 114). The page is the only place they are shown.
corpus/findings/120_field_trash_page.md
121_field_settings_edges
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. [partial]
not measured: whether the field the 500 retired can be revived, and the order valid_types take at creation. The first is the site owner's call, the second needs a new name.
| do | why |
|---|---|
| Never plan to empty a description, a display name or a list | every form is a 400, and whitespace alone is a 400 too |
Send valid_values and default_value in one PUT |
the pair is checked together, so a status list moves to new values and a new default in one request |
Treat a PUT as all or nothing |
one refused property left the others unapplied in every case sent |
Compare valid_types as an ordered list |
the order sent is the order read |
| Add and remove valid types only when the set changes | each added type creates a field on that type and each removed one spends its name |
Check every valid_types name against GET /schema, case included, before sending |
an unknown name is a 400, a wrong case is a 500 that takes the field down |
Deduplicate a status list's valid_values yourself |
a repeated code is stored twice |
corpus/findings/121_field_settings_edges.md
122_onset_entity_types
Slate, Camera, MocapTake, ShootDay and Scene create like Version: project required, code generated. None has attachments, and only Version.entity and Note.note_links reach them all. [partial]
not measured: a stock site, and enabling a hidden type: Element is off on the probed site and only the web UI turns a type on. Blocked on the site
Create every on-set row with
project;codeis optional and"New <Display Name> <id>"when omitted, exactly as Version (entity_types/Version)./schemais the switch: a hidden built-in type is absent from it and 404s by name everywhere, while its connection types stay listed. No API call turns it on; the 400 code 111 of probe 114 answers for stock types and renames too, so plan for an admin turning the type on in the web interface (not measured: no setting was changed).Link a take to its Shot through a Version (
Version.entity) or a site field; stock Slate has no Shot link.valid_typesis not enforced onVersion.entityorShot.sg_scene(field_types/entity), so check the type on the client.mocap_takesandshoot_daysare the slugs: the CamelCase name also resolves, the run-together plural does not.
corpus/findings/122_onset_entity_types.md
132_field_create_rights
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. [partial]
not measured: Manager, Vendor and the site's Artist variant: nobody active in them has impersonation on. Blocked on the site; then run 132 --write --only Manager,Vendor
The three schema writes refuse in three shapes: create and configure are 500 code 105 with
RuntimeErrorin the title, retire is 400 code 104. A client retrying 5xx would retry a refusal forever; matchdoesn't have permissionin the title before retrying.Permission is checked after the field is looked up: an absent field is a 404 for the Artist too, so a probe on a made-up name tells a caller nothing about its rights.
No call answers "may I create a field" without trying. The permission group calls describe rows only, and an Artist sees only its own group. On the probed site the Admin person read every group's row rights (probe 143 lists them); none of them names fields.
Field creation is a site-administration right on the probed site: Admin yes, Artist no. Whether Manager has it was not reachable, so a client should not infer it from Manager's row rights.
corpus/findings/132_field_create_rights.md
142_reverse_field
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.
Plan for a field on every linked type: one per type in
valid_types(probe 121), eachvisible: trueandeditable: truein that type's schema.The entity case is named after the source type's display name, not its schema name, so a slot's reverse fields change name pattern with what the site calls it. What the server picks for a second entity field from the same source to the same target was not measured.
No create property suppresses it. The 400 lists the accepted properties for an entity field, and none is about the reverse.
Retiring a reverse field retires its forward field. It is one link with two names: delete either and both go, and both names stay spent until the Trash is emptied (probe 019). Hide a reverse field rather than deleting it; whether
visible: falseis accepted on one was not measured, because the reverse was gone by then.
corpus/findings/142_reverse_field.md
157_project_custom_field
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. [partial]
not measured: Manager, Vendor and the Artist variant: nobody active in them has impersonation on. Blocked on the site; then 157 --write --only Manager
The body is the same as on any type:
data_typeand apropertieslist holdingname, plusdescriptionif wanted. Thesg_name is the last segment oflinks.self(probe 019).The display name decides the
sg_name by probe 117's rule:Onset Templatesgivessg_onset_templates,Onset Reference Kindsgivessg_onset_reference_kinds. A display name in use gives_1(probe 019) and a retired one is a 400 code 105 until the Trash is emptied (probe 117).A Project field is site-wide:
?project_id=changes nothing for an Admin, and per callereditableis false for an Artist (probe 159 has the write).Match
doesn't have permissionin a 500's title before retrying a schema write (probe 132).
corpus/findings/157_project_custom_field.md
160_jsonb_field_create
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.
| want | do |
|---|---|
| a JSON value on a type of your own | a text field holding JSON.stringify(value): stored byte for byte to 1,000,000 characters (probe 158) |
| a filter into the JSON | none on a text field beyond contains on the string. jsonb filtering exists only on the stock Note.meta (field_types/jsonb) |
a jsonb field |
not reachable over REST. The refusal is the same 400 as color and image (probe 019) |
The spec's enum predicted every answer measured: each type outside it is this 400, here or in probe 019, and each type inside it that has been sent was created (probes 019, 116, 117) except
calculated, a 500.uuidhas not been sent.field_types/jsonbstays the reference for the two stockjsonbfields. Nothing on it applies to a field a client makes, because a client cannot make one.
corpus/findings/160_jsonb_field_create.md
162_permission_rules_rest
Rules are readable over REST with their condition trees: an Admin person reads every group, a person only their own. No call writes one: PUT, POST and PATCH on the permission routes are 404.
Conditional rules are readable, correcting probe 027:
actions.<action>.conditionholds the tree and the rawpermissions.see_conditionholds the same one. Onlyconditionalhas a tree.Read rules as an Admin person through
sudo_as_login, or as the person themselves. The script reads no HumanUser group, and a person asking for another group gets 403 where the script gets 404.No REST call creates or changes a rule: the three routes answer
GETalone andPermissionRuleSet's 10 fields are read only. A rule an app needs is added in the web interface; check for it, never write it.On the probed site Vendor reads
<Bid>and<Bid Line>asallowed, and Shot as conditional on the five paths above. "See entities in assigned Projects only" is a setting of the role with no key in any of these responses; probe 166 measures its effect.
corpus/findings/162_permission_rules_rest.md