Type Alias FilePostBodyBody

Type declaration

• as_type: string

  The desired Dataset file type (a MIME type). Whether or not the chosen fileType is supported will depend on the Dataset

• Optionalcompress?: boolean

  Whether to compress the Dataset File as it's attached. Compression is achieved using gzip, resulting in a File ending .gz. By default the file will be compressed

• dataset_id: string

  The Dataset UUID for the File that you intend to attach

  Pattern

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

• dataset_version: number

  The Dataset version to attach

  Minimum

  1

• Optionalimmutable?: boolean

  Whether the Dataset File can be modified while in the Project. By default the File cannot be modified

• Optionalpath?: string

  A path within the Project to add the File, default is the project root ('/'), the mount-point within the application container. Paths must begin '/'

  Max Length

  260

  Pattern

  ^/.+$|^/$

• project_id: string

  The Project UUID you're attaching to

  Pattern

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