API docs by Redocly

SeqDB API Schema (1.0.0)

Download OpenAPI specification:Download

E-mail: info@dina-project.net License: Apache 2.0

SeqDB API Schema

Region

get region

By passing in query string, user can get available regions authorised

query Parameters
filter[rsql]
string

pass an optional search string for looking up the regions

sort
string

optional sort string, can have sort order such as descending denoted by "-"

page[offset]
integer <int32>

number of records to skip when paging

page[limit]
integer <int32> [ 0 .. 50 ]

maximum number of records to return when paging

Responses

Response samples

Content type
application/json
[
  • {
    }
]

adds a region

Adds a region

Request Body schema: application/json

region to add

required
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    }
}

Find region by ID

Returns a single region

path Parameters
Id
required
integer

ID of region to return

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

update a region

update a region

path Parameters
Id
required
integer

region id to patch

Request Body schema: application/json

region to update

required
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    }
}

delete a region

delete a region

path Parameters
Id
required
integer

region id to delete

Responses

PCR Primer

get pcr-primer

By passing in query string, user ca get available pcrPrimers authorised

query Parameters
filter[rsql]
string

pass a optional search string for looking up the pcrPrimers

sort
string

optional sort string, can have sort order such as descending denoted by "-"

page[offset]
integer <int32>

number of records to skip when paging

page[limit]
integer <int32> [ 0 .. 50 ]

maximum number of records to return when paging

Responses

Response samples

Content type
application/json
[
  • {
    }
]

adds a pcr-primer

Adds a pcr-primer

Request Body schema: application/json

pcr-primer to add

required
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    }
}

Find pcr-primer by ID

Returns a single pcr-primer

path Parameters
Id
required
integer

ID of pcr-primer to return

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

update a pcr-primer

update a pcr-primer

path Parameters
Id
required
integer

pcr-primer id to patch

Request Body schema: application/json

pcr-primer to update

required
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    }
}

delete a pcr-primer

delete a pcr-primer

path Parameters
Id
required
integer

pcr-primer id to delete

Responses

PCR Batch

get pcr-batch

By passing in query string, get available pcrBatches authorised

query Parameters
filter[rsql]
string

pass a optional search string for looking up the pcrBatches

sort
string

optional sort string, can have sort order such as descending denoted by "-"

page[offset]
integer <int32>

number of records to skip when paging

page[limit]
integer <int32> [ 0 .. 50 ]

maximum number of records to return when paging

Responses

Response samples

Content type
application/json
[
  • {
    }
]

adds a pcr-batch

Adds a pcr-batch

Request Body schema: application/json

pcr-batch to add

required
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    }
}

Find pcr-batch by ID

Returns a single pcr-batch

path Parameters
Id
required
integer

ID of pcr-batch to return

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

update a pcr-batch

update a pcr-batch

path Parameters
Id
required
integer

pcr-batch id to patch

Request Body schema: application/json

pcr-batch to update

required
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    }
}

delete a pcr-batch

delete a pcr-batch

path Parameters
Id
required
integer

pcr-batch id to delete

Responses

Sequence Batch

get seq-batch

By passing in query string, get available seqBatches authorised

query Parameters
filter[rsql]
string

pass a optional search string for looking up the seqBatches

sort
string

optional sort string, can have sort order such as descending denoted by "-"

page[offset]
integer <int32>

number of records to skip when paging

page[limit]
integer <int32> [ 0 .. 50 ]

maximum number of records to return when paging

Responses

Response samples

Content type
application/json
[
  • {
    }
]

adds a seq-batch

Adds a seq-batch

Request Body schema: application/json

seq-batch to add

required
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    }
}

Find seq-batch by ID

Returns a single seq-batch

path Parameters
Id
required
integer

ID of seq-batch to return

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

update a seq-batch

update a seq-batch

path Parameters
Id
required
integer

seq-batch id to patch

Request Body schema: application/json

seq-batch to update

required
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    }
}

delete a seq-batch

delete a seq-batch

path Parameters
Id
required
integer

seq-batch id to delete

Responses

Sequence Reaction

get seq-reaction

By passing in query string, user can get available seq-reaction authorised

query Parameters
filter[rsql]
string

pass an optional search string for looking up the seq-reaction

sort
string

optional sort string, can have sort order such as descending denoted by "-"

page[offset]
integer <int32>

number of records to skip when paging

page[limit]
integer <int32> [ 0 .. 50 ]

maximum number of records to return when paging

Responses

Response samples

Content type
application/json
[
  • {
    }
]

adds a seq-reaction

Adds a seq-reaction

Request Body schema: application/json

seq-reaction to add

required
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    }
}

Find seq-reaction by ID

Returns a single seq-reaction

path Parameters
Id
required
integer

ID of seq-reaction to return

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

update a seq-reaction

update a seq-reaction

path Parameters
Id
required
integer

seq-reaction id to patch

Request Body schema: application/json

seq-reaction to update

required
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    }
}

delete a seq-reaction

delete a seq-reaction

path Parameters
Id
required
integer

seq-reaction id to delete

Responses

Sequencing Facility

get sequencing-facility

By passing in query string, user can get available sequencing-facility authorised

query Parameters
filter[rsql]
string

pass an optional search string for looking up the sequencing-facility

sort
string

optional sort string, can have sort order such as descending denoted by "-"

page[offset]
integer <int32>

number of records to skip when paging

page[limit]
integer <int32> [ 0 .. 50 ]

maximum number of records to return when paging

Responses

Response samples

Content type
application/json
[
  • {
    }
]

adds a sequencing-facility

Adds a sequencing-facility

Request Body schema: application/json

sequencing-facility to add

required
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    }
}

Find sequencing-facility by ID

Returns a single sequencing-facility

path Parameters
Id
required
integer

ID of sequencing-facility to return

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update a sequencing-facility

update a sequencing-facility

path Parameters
Id
required
integer

sequencing-facility id to patch

Request Body schema: application/json

sequencing-facility to update

required
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    }
}

delete a sequencing-facility

delete a sequencing-facility

path Parameters
Id
required
integer

sequencing-facility id to delete

Responses

Sequence Submission

get seq-submission

By passing in query string, get available seqSubmissions authorised

query Parameters
filter[rsql]
string

pass a optional search string for looking up the seqSubmissions

sort
string

optional sort string, can have sort order such as descending denoted by "-"

page[offset]
integer <int32>

number of records to skip when paging

page[limit]
integer <int32> [ 0 .. 50 ]

maximum number of records to return when paging

Responses

Response samples

Content type
application/json
[
  • {
    }
]

adds a seq-submission

Adds a seq-submission

Request Body schema: application/json

seq-submission to add

required
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    }
}

Find seq-submission by ID

Returns a single seq-submission

path Parameters
Id
required
integer

ID of seq-submission to return

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

update a seq-submission

update a seq-submission

path Parameters
Id
required
integer

seq-submission id to patch

Request Body schema: application/json

seq-submission to update

required
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    }
}

delete a seq-submission

delete a seq-submission

path Parameters
Id
required
integer

seq-submission id to delete

Responses

Index Set

get index-set

By passing in query string, user can get available index sets

query Parameters
filter[rsql]
string

pass an optional search string for looking up the index sets

sort
string

optional sort string, can have sort order such as descending denoted by "-"

page[offset]
integer <int32>

number of records to skip when paging

page[limit]
integer <int32> [ 0 .. 50 ]

maximum number of records to return when paging

Responses

Response samples

Content type
application/json
[
  • {
    }
]

adds an index-set

Adds an index-set

Request Body schema: application/json

index set to add

required
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    }
}

Find index-set by ID

Returns a single index-set

path Parameters
Id
required
integer

ID of index-set to return

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

update an index-set

update an index-set

path Parameters
Id
required
integer

index-set id to patch

Request Body schema: application/json

index set to update

required
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    }
}

delete an index-set

delete an index-set

path Parameters
Id
required
integer

index-set id to delete

Responses

NGS Index

get ngs-index

By passing in query string, user can get available ngs indexes

query Parameters
filter[rsql]
string

pass an optional search string for looking up the ngs indexes

sort
string

optional sort string, can have sort order such as descending denoted by "-"

page[offset]
integer <int32>

number of records to skip when paging

page[limit]
integer <int32> [ 0 .. 50 ]

maximum number of records to return when paging

Responses

Response samples

Content type
application/json
[
  • {
    }
]

adds an ngs-index

Adds an ngs-index

Request Body schema: application/json

ngs-index to add

required
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    }
}

Find ngs-index by ID

Returns a single ngs-index

path Parameters
Id
required
integer

ID of ngs-index to return

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

update an ngs-index

update an ngs-index

path Parameters
Id
required
integer

ngs-index id to patch

Request Body schema: application/json

ngs-index to update

required
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    }
}

delete an ngs-index

delete an ngs-index

path Parameters
Id
required
integer

ngs-index id to delete

Responses

Thermocylcer Profile

get thermocycler-profile

By passing in query string, get available thermocyclerProfiles authorised

query Parameters
filter[rsql]
string

pass a optional search string for looking up the thermocyclerProfiles

sort
string

optional sort string, can have sort order such as descending denoted by "-"

page[offset]
integer <int32>

number of records to skip when paging

page[limit]
integer <int32> [ 0 .. 50 ]

maximum number of records to return when paging

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Thermocycler Profile

adds a thermocycler-profile

Adds a thermocycler-profile

Request Body schema: application/json

thermocycler-profile to add

required
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    }
}

Find thermocycler-profile by ID

Returns a single thermocycler-profile

path Parameters
Id
required
integer

ID of thermocycler-profile to return

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

update a thermocycler-profile

update a thermocycler-profile

path Parameters
Id
required
integer

thermocycler-profile id to patch

Request Body schema: application/json

thermocycler-profile to update

required
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    }
}

delete a thermocycler-profile

delete a thermocycler-profile

path Parameters
Id
required
integer

thermocycler-profile id to delete

Responses