Sign in
Raw Data

Update a raw-data record's metadata

Update name/metadata. Does not replace the file.

patch/raw_data/{raw_data_id}

Path parameters

raw_data_idstring required

Request body

namestring nullable

New label.

sourcestring nullable

New free-text provenance (where the raw file came from).

metadataobject nullable

Replacement metadata dict.

Response

Successful Response

project_idstring required

Owning project ID (required).

namestring required

User-provided label for the raw file.

sourcestring nullable

Free-text provenance: where this raw file came from (a URL, DOI, S3 URI, vendor/cycler export description, etc.).

metadataobject

Loose free-form metadata.

idstring required

Unique identifier.

organization_idstring required

Owning organization.

filenamestring required

Original uploaded filename.

content_typestring nullable

MIME type, if known.

size_bytesinteger nullable

File size in bytes.

storage_pathstring required

Path within the raw-data bucket.

processing_status'pending' | 'queued' | 'processing' | 'needs_review' | 'awaiting_cell' | 'done' | 'failed'

Ingestion lifecycle: pending | queued | processing | needs_review | awaiting_cell | done | failed. See src.pydantic_models.raw_data_ingestion for what each means.

processing_errorstring nullable

Terminal ingestion failure message, if any.

processed_atstring date-time nullable

When ingestion last reached a terminal state.

readerstring nullable

Cycler format detected on parse (arbin, maccor, ...).

created_bystring nullable

User ID of the uploader.

created_atstring date-time required

Creation timestamp.

updated_atstring date-time required

Last update timestamp.

Changes