Type Alias DatasetPostBodyBody

DatasetPostBodyBody: {
    as_filename?: string;
    dataset_file: Blob;
    dataset_id?: string;
    dataset_type: string;
    format_extra_variables?: string;
    skip_molecule_load?: boolean;
    unit_id: string;
}

Type declaration

  • Optionalas_filename?: string

    An optional new filename to use for the uploaded Dataset. The Dataset will be stored using this name.

    Min Length

    1

    Max Length

    128

  • dataset_file: Blob
  • Optionaldataset_id?: string

    If provided the Dataset becomes a new version of the Dataset named. If not provided this Dataset 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. Values like chemical/x-mdl-sdfile, chemical/x-mdl-molfile, and chemical/x-pdb are permitted. See the /type endpoint for a full list of types.

  • 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.

  • 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

  • unit_id: string

    The Organisational Unit you want the Dataset to belong to

    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