Creates a workflow.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request syntax

POST /gs/workflow HTTP/1.1
Content-Type:application/json

{
  "workflow_type" : "String",
  "service" : "String",
  "mapping_oss_region" : "String",
  "mapping_fastq_first_filename" : "String",
  "mapping_fastq_second_filename" : "String",
  "mapping_bucket_name" : "String",
  "mapping_fastq_path" : "String",
  "mapping_reference_path" : "String",
  "mapping_is_mark_dup" : "String",
  "mapping_bam_out_path" : "String",
  "mapping_bam_out_filename" : "String",
  "wgs_oss_region" : "String",
  "wgs_fastq_first_filename" : "String",
  "wgs_fastq_second_filename" : "String",
  "wgs_bucket_name" : "String",
  "wgs_fastq_path" : "String",
  "wgs_reference_path" : "String",
  "wgs_vcf_out_path" : "String",
  "wgs_vcf_out_filename" : "String"
}

Request parameters

Table 1. Request body parameters
Parameter Type Required Example Description
workflow_type String Yes mapping

The type of the workflow. Valid values: wgs and mapping.

service String No s

The type of service-level agreement (SLA). Valid values:

  • s: the silver level (S-level). It requires 1 extra minute to process every 1.5 billion base pairs beyond the limit of 90 billion base pairs.
  • g: the gold level (G-level). It requires 1 extra minute to process every 2 billion base pairs beyond the limit of 90 billion base pairs.
  • p: the platinum level (P-level). It requires 1 extra minute to process every 3 billion base pairs beyond the limit of 90 billion base pairs.
mapping_oss_region String No cn-hangzhou

The region where the Object Storage Service (OSS) bucket that stores the data of the mapping workflow is deployed.

mapping_fastq_first_filename String No MGISEQ2000_PCR-free_NA12878_1_V100003043_L01_1.fq.gz

The name of the first FASTQ file of the mapping workflow.

mapping_fastq_second_filename String No MGISEQ2000_PCR-free_NA12878_1_V100003043_L01_2.fq.gz

The name of the second FASTQ file of the mapping workflow.

mapping_bucket_name String No gene-shenzhen

The name of the OSS bucket that stores the data of the mapping workflow.

mapping_fastq_path String No fastq/MGISEQ2000

The path of the FASTQ files of the mapping workflow.

mapping_reference_path String No reference/hg19

The path of the reference files of the mapping workflow.

mapping_is_mark_dup String No true

Specifies whether to mark duplicate values.

mapping_bam_out_path String No output/bamDirName

The output path of the Binary Alignment Map (BAM) file.

mapping_bam_out_filename String No abc.bam

The name of the output BAM file.

wgs_oss_region String No cn-shenzhen

The region where the OSS bucket that stores the data of the whole genome sequencing (WGS) workflow is deployed.

wgs_fastq_first_filename String No MGISEQ2000_PCR-free_NA12878_1_V100003043_L01_1.fq.gz

The name of the first FASTQ file of the WGS workflow.

wgs_fastq_second_filename String No MGISEQ2000_PCR-free_NA12878_1_V100003043_L01_2.fq.gz

The name of the second FASTQ file of the WGS workflow.

wgs_bucket_name String No gene-shenzhen

The name of the OSS bucket that stores the data of the WGS workflow.

wgs_fastq_path String No fastq/MGISEQ2000

The path of the FASTQ files of the WGS workflow.

wgs_reference_path String No reference/hg19

The path of the reference files of the WGS workflow.

wgs_vcf_out_path String No output/vcf

The output path of the Variant Call Format (VCF) file.

wgs_vcf_out_filename String No abc.vcf

The name of the output VCF file.

Response syntax

HTTP/1.1 200 OK
Content-Type:application/json

{
  "JobName" : "String"
}

Response parameters

Table 2. Response body parameters
Parameter Type Example Description
JobName String mapping-gpu-66xv7

The name of the workflow that is created.

Examples

POST /gs/workflow HTTP/1.1
Host:cs.aliyuncs.com
Content-Type:application/json

{
  "workflow_type" : "mapping",
  "service" : "s",
  "mapping_oss_region" : "cn-hangzhou",
  "mapping_fastq_first_filename" : "MGISEQ2000_PCR-free_NA12878_1_V100003043_L01_1.fq.gz",
  "mapping_fastq_second_filename" : "MGISEQ2000_PCR-free_NA12878_1_V100003043_L01_2.fq.gz",
  "mapping_bucket_name" : "gene-shenzhen",
  "mapping_fastq_path" : "fastq/MGISEQ2000",
  "mapping_reference_path" : "reference/hg19",
  "mapping_is_mark_dup" : "true",
  "mapping_bam_out_path" : "output/bamDirName",
  "mapping_bam_out_filename" : "abc.bam",
  "wgs_oss_region" : "cn-shenzhen",
  "wgs_fastq_first_filename" : "MGISEQ2000_PCR-free_NA12878_1_V100003043_L01_1.fq.gz",
  "wgs_fastq_second_filename" : "MGISEQ2000_PCR-free_NA12878_1_V100003043_L01_2.fq.gz",
  "wgs_bucket_name" : "gene-shenzhen",
  "wgs_fastq_path" : "fastq/MGISEQ2000",
  "wgs_reference_path" : "reference/hg19",
  "wgs_vcf_out_path" : "output/vcf",
  "wgs_vcf_out_filename" : "abc.vcf"
}

Description of the sample request

Create a WGS workflow:
```
POST /gs/workflow HTTP/1.1 
Content-Type:application/json
{
  "workflow_type" : "wgs",
  "service" : "s",
  "wgs_oss_region" : "cn-shenzhen",
  "wgs_fastq_first_filename" : "MGISEQ2000_PCR-free_NA12878_1_V100003043_L01_1.fq.gz",
  "wgs_fastq_second_filename" : "MGISEQ2000_PCR-free_NA12878_1_V100003043_L01_2.fq.gz",
  "wgs_bucket_name" : "gene-shenzhen",
  "wgs_fastq_path" : "fastq/MGISEQ2000",
  "wgs_reference_path" : "reference/hg19",
  "wgs_vcf_out_path" : "output/vcf",
  "wgs_vcf_out_filename" : "abc.vcf"
}
```

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<JobName>mapping-gpu-66xv7</JobName>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "JobName" : "mapping-gpu-66xv7"
}

Error codes

For a list of error codes, visit the API Error Center.