Put Data Fields

Full-replacement write of the projection list on the record's current editable version.

Semantics

  • PUT, not PATCH. The wire intent is full replacement โ€” omitting an entry from the body removes it.
  • Empty array clears all projections (a future GET returns "report_data_fields": []).
  • Operates on the current version only. To carry projections forward when cutting a new version, include report_data_fields on the version-cut body โ€” see the Reprocess endpoints and the conceptual overview for the inherit / clear / replace tri-state semantics on cut.

Entry shape

{
  "key": "client_id",
  "paths": ["clientId", "client_id"],
  "label": "Client ID",
  "scope": "plot"
}
FieldRequiredNotes
keyyesOutput key in the report's per-plot data_fields block. Pattern ^[a-z][a-z0-9_]*$, โ‰ค128 chars.
pathsyes1โ€“16 dotted-path lookups against the resolution root (see scope). First non-null wins. Each path โ‰ค512 chars.
labelnoDisplay label for the report renderer. 1โ€“256 chars.
scopeno"plot" (default) resolves paths against the plot's own upload row; "facility" resolves against the plot's linked facility upload (plot โ†’ supply_shed โ†’ facility). Facility-scoped entries resolve to null when the plot's shed has no linked facility.

Validation errors

  • 400 โ€” missing required field, oversize / mistyped value, duplicate key, more than 64 entries, more than 16 paths per entry, or key violates the regex.
  • 404 โ€” record not visible to your organization.

Frozen versions

The endpoint always targets the current version. If the current version is frozen (already submitted), the underlying write is rejected โ€” cut a new version first.

Required scope: ingestions:write