VCF Samples
post
/ohfapi/omics/samples/vcf
This API initiates the VCF loading process.
Request
Supported Media Types
- application/json
Root Schema : VcfLoaderParam
Type:
Show Source
object
-
customFormat(optional):
string
Custom Format
-
datasourceName(optional):
string
Data Source Name - The default value is CDM.
-
dnaReferenceVersion:
string
DNA Reference Version
-
file:
string
File
-
fileType(optional):
string
File Type - The default value is 'VCF'.
-
fileURI(optional):
string
File URI
-
fileVersion(optional):
string
File Version
-
loadMode(optional):
string
Load Mode - The default value is 'VCF'.
-
maxFormat(optional):
integer(int32)
Max Format - The default value is '32'.
-
parallelDegree(optional):
integer(int32)
Parallel Degree
-
readSize(optional):
integer(int64)
Read Size
-
speciesName(optional):
string
Species Name - The default value is 'Homo sapiens'.
-
specimenVendor(optional):
string
Specimen Vendor
-
studyName:
string
Study Name
-
useAppend(optional):
string
Use Append - The default value is 'N'.
-
validateNumberFlag(optional):
string
Validate Number Flag - The default value is 'N'.
Security
-
basicAuth: basic
Type:
basic
Response
Supported Media Types
- application/json
202 Response
Successful operation: Accepted
Location: /omics/jobstatus/{jobId}
500 Response
Error message object