scicat-backend-next documentation
  1. Classes
  2. CreateSampleDto

File

src/samples/dto/create-sample.dto.ts

Extends

OwnableDto

Index

Properties

Properties

Readonly Optional description
Type : string
Decorators :
@ApiProperty({type: String, required: false, description: 'A description of the sample.'})
@IsString()
@IsOptional()
Defined in src/samples/dto/create-sample.dto.ts:32
Readonly Optional isPublished
Type : boolean
Decorators :
@ApiProperty({type: Boolean, default: false, required: false, description: 'Flag is true when data are made publicly available.'})
@IsBoolean()
@IsOptional()
Defined in src/samples/dto/create-sample.dto.ts:52
Readonly Optional owner
Type : string
Decorators :
@ApiProperty({type: String, required: false, description: 'The owner of the sample.'})
@IsString()
@IsOptional()
Defined in src/samples/dto/create-sample.dto.ts:23
Readonly Optional sampleCharacteristics
Type : Record<string | >
Decorators :
@ApiProperty({type: Object, default: undefined, required: false, description: 'JSON object containing the sample characteristics metadata.'})
@IsObject()
@IsOptional()
Defined in src/samples/dto/create-sample.dto.ts:42
Readonly Optional sampleId
Type : string
Decorators :
@ApiProperty({type: String, required: false, description: 'Globally unique identifier of a sample. This could be provided as an input value or generated by the system.'})
@IsString()
@IsOptional()
Defined in src/samples/dto/create-sample.dto.ts:14
Readonly Optional accessGroups
Type : string[]
Decorators :
@ApiProperty({type: undefined, required: false, description: 'List of groups which have access to this item.'})
@IsOptional()
@IsString({each: true})
Inherited from OwnableDto
Defined in OwnableDto:22
Readonly Optional instrumentGroup
Type : string
Decorators :
@ApiProperty({type: String, required: false, description: 'Group of the instrument which this item was acquired on.'})
@IsOptional()
@IsString()
Inherited from OwnableDto
Defined in OwnableDto:31
Readonly ownerGroup
Type : string
Decorators :
@ApiProperty({type: String, required: true, description: 'Name of the group owning this item.'})
@IsString()
Inherited from OwnableDto
Defined in OwnableDto:11 
import { ApiProperty } from "@nestjs/swagger";
import { IsString, IsBoolean, IsObject, IsOptional } from "class-validator";
import { OwnableDto } from "src/common/dto/ownable.dto";

export class CreateSampleDto extends OwnableDto {
  @ApiProperty({
    type: String,
    required: false,
    description:
      "Globally unique identifier of a sample. This could be provided as an input value or generated by the system.",
  })
  @IsString()
  @IsOptional()
  readonly sampleId?: string;

  @ApiProperty({
    type: String,
    required: false,
    description: "The owner of the sample.",
  })
  @IsString()
  @IsOptional()
  readonly owner?: string;

  @ApiProperty({
    type: String,
    required: false,
    description: "A description of the sample.",
  })
  @IsString()
  @IsOptional()
  readonly description?: string;

  @ApiProperty({
    type: Object,
    default: {},
    required: false,
    description: "JSON object containing the sample characteristics metadata.",
  })
  @IsObject()
  @IsOptional()
  readonly sampleCharacteristics?: Record<string, unknown>;

  @ApiProperty({
    type: Boolean,
    default: false,
    required: false,
    description: "Flag is true when data are made publicly available.",
  })
  @IsBoolean()
  @IsOptional()
  readonly isPublished?: boolean;
}

results matching ""

    No results matching ""