Update Data 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"
  }'

import requests

response = requests.patch(
    "https://api.atomscale.ai/data_entries/d290f1ee-6c54-4b01-90e6-d701748f0851",
    headers={
        "X-API-KEY": "YOUR_API_KEY",
        "Content-Type": "application/json"
    },
    json={
        "char_source_type": "rheed_video",
        "pipeline_status": "success",
        "raw_name": "rheed_video_2024_01_15.mp4"
    }
)
entry = response.json()

{
  "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"
}

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"
  }'

import requests

response = requests.patch(
    "https://api.atomscale.ai/data_entries/d290f1ee-6c54-4b01-90e6-d701748f0851",
    headers={
        "X-API-KEY": "YOUR_API_KEY",
        "Content-Type": "application/json"
    },
    json={
        "char_source_type": "rheed_video",
        "pipeline_status": "success",
        "raw_name": "rheed_video_2024_01_15.mp4"
    }
)
entry = response.json()

{
  "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.

string

required

The UUID of the data entry

string

Characterization source type. One of: rheed_video, xps, sem, metrology, optical, raman, photoluminescence, ellipsometry, sims, oes, xrd, afm

string

Processing pipeline status. One of: success, pending, error, running

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_video, 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

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"
  }'

import requests

response = requests.patch(
    "https://api.atomscale.ai/data_entries/d290f1ee-6c54-4b01-90e6-d701748f0851",
    headers={
        "X-API-KEY": "YOUR_API_KEY",
        "Content-Type": "application/json"
    },
    json={
        "char_source_type": "rheed_video",
        "pipeline_status": "success",
        "raw_name": "rheed_video_2024_01_15.mp4"
    }
)
entry = response.json()

{
  "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"
}

List Data Entries

Delete Data Entries

Introduction

Data Catalogue

Data Upload

Projects

Physical Samples

RHEED

SEM

Spectroscopy

OES

SIMS

Optical

Metrology

Tags

Target Materials

Instruments

Response

​Response

Response