Skip to main content
PATCH
Updates the metadata of an existing data catalogue entry. All body fields are optional, so you can update only the fields you need.
string
required
The UUID of the data entry
string
Characterization source type. Supported values: rheed, rheed_image, rheed_xscan, xps, sem, tool_state, optical, raman, photoluminescence, recipe, ellipsometry, sims, oes, xrd, xrr. The legacy RHEED names rheed_stationary, rheed_rotating, and rheed_video are still accepted and treated as rheed.
string
Processing pipeline status. One of: success, pending, error, running, quarantined, stream_active, stream_paused, stream_interrupted, stream_finalizing, stream_error
string
Original filename of the uploaded data

Response

Returns the full data catalogue object. Key fields are shown below (the full response includes additional metadata fields).
string
Data entry UUID
string
Original filename of the uploaded data
string
Characterization source type (e.g., rheed, xps, sem)
string
Processing pipeline status
string
Associated physical sample UUID
string
ISO 8601 timestamp of upload
string
ISO 8601 timestamp of the last update
number
Size of the raw file in gigabytes
string
ID of the user who owns the entry