Story #5334

[API] Implement GET /callsets/{callset-name}/gvcf API call

Added by Sarah Guthrie over 4 years ago. Updated 3 months ago.

Status:
New
Priority:
Normal
Assigned To:
-
Target version:
Start date:
03/18/2015
Due date:
03/18/2015
% Done:

0%

Estimated time:
Story points:
-

Description

Purpose is to return list of gVCF-formatted variations from reference for a callset.

See lightning/docs for specifications

History

#1 Updated by Sarah Guthrie about 4 years ago

  • Subject changed from Add API Call to Lightning: GET vcf-like-variants to [API] [Sprite] Implement POST /callsets/{callset-name}/gvcf and POST /callsets/{callset-name}/vcf API calls
  • Description updated (diff)

#2 Updated by Sarah Guthrie about 4 years ago

  • Description updated (diff)

#3 Updated by Sarah Guthrie about 4 years ago

  • Description updated (diff)

Specifications - details:

POST /callsets/{callset-name}/gvcf
Requires a request containing information about the loci to return. Returns a list of gVCF lines for the callset at these loci.

Request body:

{

'loci' : [ <Locus>, <Locus>, ... ] OR { <string> : <Locus>, <string> : <Locus>, ... }

}

Response body:

{

(<string>, <Locus>) OR <Locus> : [

<gVCF-line>,
<gVCF-line>,
...

],
(<string>, <Locus>) OR <Locus> : [

<gVCF-line>,
<gVCF-line>,
...

],
...

}

POST /callsets/{callset-name}/vcf
Requires a request containing information about the loci to return. Returns a list of VCF lines for the callset at these loci.

Request body:

{

'loci' : [ <Locus>, <Locus>, ... ] OR { <string> : <Locus>, <string> : <Locus>, ... },

}

Response body:

{

(<string>, <Locus>) OR <Locus> : [

<VCF-line>,
<VCF-line>,
...

],
(<string>, <Locus>) OR <Locus> : [

<VCF-line>,
<VCF-line>,
...

],
...

}

#4 Updated by Sarah Guthrie almost 4 years ago

  • Subject changed from [API] [Sprite] Implement POST /callsets/{callset-name}/gvcf and POST /callsets/{callset-name}/vcf API calls to [API] Implement GET /callsets/{callset-name}/gvcf
  • Description updated (diff)

#5 Updated by Sarah Guthrie almost 4 years ago

  • Project changed from Curoverse Science to Lightning
  • Subject changed from [API] Implement GET /callsets/{callset-name}/gvcf to [API] Implement GET /callsets/{callset-name}/gvcf API call

#6 Updated by Sarah Guthrie almost 4 years ago

  • Target version set to Future sprints (Lightning)

#7 Updated by Jiayong Li 3 months ago

  • Target version changed from Future sprints (Lightning) to Tiling Future

Also available in: Atom PDF