Partek Flow Documentation

Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Returns data about a specified library file

 

Required parameters

 

For upload:

Parameter

Type

Description

file

binary

The file content.

file_type

string

The type of library file:  reference_genome. The list of available library file types is returned by /library_files/types

assembly

string

The assembly of the library file

 

...

 

Parameter

Type

Description

file_type

string

The type of library file:  reference_genome. The list of available library file types is returned by /library_files/types

assembly

string

The assembly of the library file

 

...

404: Returned if no library file is managed for the specified library file and assembly

 

/library_files/types


POST, GET

Returns the list of library file types that the server can managed


Responses

200: application/json

The list of manageable library file types:  Genome sequence, cytoBand.txt, Annotation model, Bowtie Index, Bowtie Colorspace Index, Bowtie2 Index, Tmap Index, BWA Index, SHRiMP2 Index, SHRiMP2 Colorspace Index, GSNAP Index, STAR Index, STAR 2.4.1d Index, Isaac2 Index, GSNAP 2015-12-31 (v8) Index, Variant database, Variant frequencies, Gene Set, SnpEff, VEP, Kraken Database

 

/library_files/list


POST, GET

Returns information about library files managed by the server

Required  

Optional parameters

 

.

Parameter

Type

Description

assemblystringThe assembly

 

Optional parameters

 

Parameter

Type

Description

annotation_model OR

annotationModel

stringThe annotation model

file_type OR

fileType

stringThe type of library file. The list of available library file types is returned by /library_files/types

description

string

Filter the library file list to those that match this description.

idintegerThe ID of the library file

 

Responses

200: application/json

The assembly, annotation model, filetype, description and id for each library file managed for the specified assembly.

400: Returned if the assembly parameter is missing.

 

Example

http://example.com:8080/flow/api/v1/library_files/list?assembly=hg19

[
 {
   "description": "Reference sequence",
   "id": 1
 },

{
   "description": "Bowtie index",
   "id": 2
 }

...

that passes the filters.

Pipelines

/pipelines


POST, GET

...