Skip to main content
PATCH
/
data_entries
/
{data_id}
curl -X PATCH "https://api.atomscale.ai/data_entries/d290f1ee-6c54-4b01-90e6-d701748f0851" \
  -H "X-API-KEY: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "char_source_type": "rheed_video",
    "pipeline_status": "success",
    "raw_name": "rheed_video_2024_01_15.mp4"
  }'

{
  "data_id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
  "raw_name": "rheed_video_2024_01_15.mp4",
  "char_source_type": "rheed_video",
  "pipeline_status": "success",
  "physical_sample_id": "a1b2c3d4-5678-90ab-cdef-1234567890ab",
  "upload_datetime": "2024-01-15T10:30:00Z",
  "last_updated": "2024-01-15T14:00:00Z",
  "raw_size_gb": 1.2,
  "user_id": "user_abc123",
  "version": "0.269.1"
}
Updates the metadata of an existing data catalogue entry. All body fields are optional, so you can update only the fields you need.
​
data_id
string
required
The UUID of the data entry
​
char_source_type
string
Characterization source type. One of: rheed_video, xps, sem, metrology, optical, raman, photoluminescence, ellipsometry, sims, oes, xrd, afm
​
pipeline_status
string
Processing pipeline status. One of: success, pending, error, running
​
raw_name
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).
​
data_id
string
Data entry UUID
​
raw_name
string
Original filename of the uploaded data
​
char_source_type
string
Characterization source type (e.g., rheed_video, xps, sem)
​
pipeline_status
string
Processing pipeline status
​
physical_sample_id
string
Associated physical sample UUID
​
upload_datetime
string
ISO 8601 timestamp of upload
​
last_updated
string
ISO 8601 timestamp of the last update
​
raw_size_gb
number
Size of the raw file in gigabytes
​
user_id
string
ID of the user who owns the entry
curl -X PATCH "https://api.atomscale.ai/data_entries/d290f1ee-6c54-4b01-90e6-d701748f0851" \
  -H "X-API-KEY: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "char_source_type": "rheed_video",
    "pipeline_status": "success",
    "raw_name": "rheed_video_2024_01_15.mp4"
  }'

{
  "data_id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
  "raw_name": "rheed_video_2024_01_15.mp4",
  "char_source_type": "rheed_video",
  "pipeline_status": "success",
  "physical_sample_id": "a1b2c3d4-5678-90ab-cdef-1234567890ab",
  "upload_datetime": "2024-01-15T10:30:00Z",
  "last_updated": "2024-01-15T14:00:00Z",
  "raw_size_gb": 1.2,
  "user_id": "user_abc123",
  "version": "0.269.1"
}