Type Alias DatasetPutBodyBody

DatasetPutBodyBody: {
    dataset_id?: string;
    dataset_type: string;
    file_name: string;
    format_extra_variables?: string;
    path: string;
    project_id: string;
    skip_molecule_load?: boolean;
    unit_id?: string;
}

Type declaration

  • Optionaldataset_id?: string

    If provided the File becomes a new version of the Dataset named. If not provided this File becomes the first version of a new Dataset, whose ID is returned to you on success.

    Pattern

    ^(dataset-[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}|)$

  • dataset_type: string

    The MIME type of the Dataset

  • file_name: string

    The file name of the file in the Project path to load as a new Dataset.

    Min Length

    1

    Max Length

    128

  • Optionalformat_extra_variables?: string

    Extra variables (text) presented to the Dataset format-support container, which occurs during the upload and database processing stage. The content of the text is Dataset type specific.

  • path: string

    The Project path of the file.

    Min Length

    1

    Max Length

    260

    Pattern

    ^/.+$|^/$

  • project_id: string

    The Project the file belongs to

    Pattern

    ^project-[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$

  • Optionalskip_molecule_load?: boolean

    If set the post-format database load action is skipped. This means the dataset is uploaded but its molecules are not entered into the Data Manager database. This can save significant time if you're just experimenting with the dataset and do not need the molecules in the database

  • Optionalunit_id?: string

    The Organisational Unit you want the Dataset to belong to. If not supplied the Project Unit is used

    Pattern

    ^unit-[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$

Settings

Member Visibility