MultiBlast Report Service v2.0.0

Resources

Lists the current user's blast report jobs.

Parameters

Parameter	Type	Description
query_job_id Query Job ID	string	Filters the results of the endpoint down to only report jobs that belong to the given target query job ID. Pattern: ^[\dA-Fa-f]{32}$ Min. length: 32 Max. length: 32

Parameter

Type

Description

Query

query_job_id Query Job ID

string

Filters the results of the endpoint down to only report jobs that belong to the given target query job ID.

Pattern: ^[\dA-Fa-f]{32}$

Min. length: 32

Max. length: 32

curl -X GET \
  undefined/jobs?query_job_id=<value>

Parameter	Type	Description
[] Report Job List Entry	object	Short-form details about a report job that has been submitted. This object is intended to appear in a list of similar objects for report job list endpoints. Inherits: object
[].reportJobID* Report Job ID	string	Hash ID of the report job. Pattern: ^[\dA-Fa-f]{32}$ Min. length: 32 Max. length: 32
[].queryJobID* Query Job ID	string	Hash ID of the source query job. Pattern: ^[\dA-Fa-f]{32}$ Min. length: 32 Max. length: 32
[].status* Job Status	string	Current status of the represented report job. Enum: queued in-progress complete failed expired Inherits: lib.JobStatus
[].userMeta Job Meta	object	User provided metadata about the represented report job. Inherits: lib.ReportJobUserMeta
[].userMeta.summary Summary	string	Optional, one line user summary about a target job. Max. length: 512
[].userMeta.description Description	string	Optional, longform description of a target job.

Unauthorized UnauthorizedError

application/json

Unauthenticated client requested a resource that requires authentication.

Discriminator: status

Discriminator value: unauthorized

Inherits: error.Error

Parameter	Type	Description
status*	string	Enum: bad-request unauthorized forbidden not-found bad-method invalid-input server-error Inherits: error.ErrorType
message*	string

Response Body

{
  "status": "unauthorized",
  "message": "users must be logged in to access this resource"
}

Discriminator: status

Discriminator value: server-error

Inherits: error.Error

Parameter	Type	Description
status*	string	Enum: bad-request unauthorized forbidden not-found bad-method invalid-input server-error Inherits: error.ErrorType
message*	string
requestId*	string

Response Body

{
  "status": "server-error",
  "message": "Datastore connection lost",
  "requestId": "b296c3d9-4032-41b1-906e-c97ccfc447e3"
}

Creates a new report job from the posted configuration.

curl -X POST \
  -H "Content-type: application/json"
  -d @body.json \
  undefined/jobs

Report Job Request ReportJobPostRequest

application/json

Request body sent to start a new report job.

Inherits: object

Parameter Type Description

queryJobID*

string

Pattern: ^[\dA-Fa-f]{32}$

Min. length: 32

Max. length: 32

blastConfig

object

Default value: {"formatType":"pairwise"}

Inherits: lib.BlastFormatConfig

blastConfig.formatType Format Type

string

Identifier	Description
pairwise	Pairwise
query-anchored-with-identities	Query-anchored showing identities
query-anchored-no-identities	Query-anchored no identities
flat-query-anchored-with-identities	Flat query-anchored showing identities
flat-query-anchored-no-identities	Flat query-anchored no identities
xml	BLAST XML
tabular	Tabular
tabular-with-comments	Tabular with comment lines
seqalign-text	Seqalign (Text ASN.1)
seqalign-binary	Seqalign (Binary ASN.1)
csv	Comma-separated values
asn1	BLAST archive (ASN.1)
seqalign-json	Seqalign (JSON)
multi-file-blast-json	Multiple-file BLAST JSON
multi-file-blast-xml2	Multiple-file BLAST XML2
single-file-blast-json	Single-file BLAST JSON
single-file-blast-xml2	Single-file BLAST XML2
sam	Sequence Alignment/Map (SAM)
organism-report	Organism Report

Default value: "pairwise"

Enum:

pairwise
query-anchored-with-identities
query-anchored-no-identities
flat-query-anchored-with-identities
flat-query-anchored-no-identities
xml
tabular
tabular-with-comments
seqalign-text
seqalign-binary
csv
asn1
seqalign-json
multi-file-blast-json
multi-file-blast-xml2
single-file-blast-json
single-file-blast-xml2
sam
organism-report

Inherits: lib.BlastOutFormat

blastConfig.formatFields Report Fields

array

Fields to include in the generated report.

Custom field selection is only valid for the following formatType values:

tabular
tabular-with-comments
csv
sam

For all other formatType values, including this field is an error.

blastConfig.formatFields[] Blast Report Field

string

Field	Meaning
qseqid	Query Seq-id
qgi	Query GI
qacc	Query accesion
qaccver	Query accesion.version
qlen	Query sequence length
sseqid	Subject Seq-id
sallseqid	All subject Seq-id(s), separated by a ';'
sgi	Subject GI
sallgi	All subject GIs
sacc	Subject accession
saccver	Subject accession.version
sallacc	All subject accessions
slen	Subject sequence length
qstart	Start of alignment in query
qend	End of alignment in query
sstart	Start of alignment in subject
send	End of alignment in subject
qseq	Aligned part of query sequence
sseq	Aligned part of subject sequence
evalue	Expect value
bitscore	Bit score
score	Raw score
length	Alignment length
pident	Percentage of identical matches
nident	Number of identical matches
mismatch	Number of mismatches
positive	Number of positive-scoring matches
gapopen	Number of gap openings
gaps	Total number of gaps
ppos	Percentage of positive-scoring matches
frames	Query and subject frames separated by a '/'
qframe	Query frame
sframe	Subject frame
btop	Blast traceback operations (BTOP)
staxid	Subject Taxonomy ID
ssciname	Subject Scientific Name
scomname	Subject Common Name
sblastname	Subject Blast Name
sskingdom	Subject Super Kingdom
staxids	unique Subject Taxonomy ID(s), separated by a ';' (in numerical order)
sscinames	unique Subject Scientific Name(s), separated by a ';'
scomnames	unique Subject Common Name(s), separated by a ';'
sblastnames	unique Subject Blast Name(s), separated by a ';' (in alphabetical order)
sskingdoms	unique Subject Super Kingdom(s), separated by a ';' (in alphabetical order)
stitle	Subject Title
salltitles	All Subject Title(s), separated by a '<>'
sstrand	Subject Strand
qcovs	Query Coverage Per Subject
qcovhsp	Query Coverage Per HSP
qcovus	Query Coverage Per Unique Subject (blastn only)
SQ	Include Sequence Data
SR	Subject as Reference Seq
std	'qaccver saccver pident length mismatch gapopen qstart qend sstart send evalue bitscore'

Enum:

qseqid
qgi
qacc
qaccver
qlen
sseqid
sallseqid
sgi
sallgi
sacc
saccver
sallacc
slen
qstart
qend
sstart
send
qseq
sseq
evalue
bitscore
score
length
pident
nident
mismatch
positive
gapopen
gaps
ppos
frames
qframe
sframe
btop
staxid
ssciname
scomname
sblastname
sskingdom
staxids
sscinames
scomnames
sblastnames
sskingdoms
stitle
salltitles
sstrand
qcovs
qcovhsp
qcovus
SQ
SR
std

Inherits: lib.BlastOutField

blastConfig.showGIs Show GIs

boolean

Show NCBI GIs in deflines?

blastConfig.numDescriptions Number of Descriptions

integer

Number of database sequences to show one-line descriptions for.

Only applicable for the following formatType values:

pairwise
query-anchored-with-identities
query-anchored-no-identities
flat-query-anchored-with-identities
flat-query-anchored-no-identities

Incompatible with maxTargetSequences.

Format: int

blastConfig.numAlignments Number of Alignments

integer

Number of database sequences to show alignments for.

Incompatible with maxTargetSequences.

Format: int

blastConfig.lineLength Line Length

integer

Line length for formatting alignments

Only applicable for the following formatType values:

pairwise
query-anchored-with-identities
query-anchored-no-identities
flat-query-anchored-with-identities
flat-query-anchored-no-identities

Incompatible with maxTargetSequences.

Min. value: 1

Format: int

blastConfig.sortHits Sort Hits

string

Sorting option for hits.

Only applicable for the following formatType values:

pairwise
query-anchored-with-identities
query-anchored-no-identities
flat-query-anchored-with-identities
flat-query-anchored-no-identities

Enum:

by-evalue
by-bit-score
by-total-score
by-percent-identity
by-query-coverage

Inherits: lib.BlastHitSorting

blastConfig.sortHSPs Sort HSPs

string

Sorting option for HSPs.

Only applicable for formatType value pairwise.

Enum:

by-hsp-evalue
by-hsp-score
by-hsp-query-start
by-hsp-percent-identity
by-hsp-subject-start

Inherits: lib.BlastHSPSorting

blastConfig.maxTargetSequences Max Target Sequences

integer

Maximum number of aligned sequences to keep.

Incompatible with:

numDescriptions
numAlignments

Min. value: 5

blastConfig.parseDefLines Parse Query Definition Lines

boolean

Should the query and subject defline(s) be parsed?

addToUserCollection

boolean

Default value: true

userMeta

object

User provided metadata about a report job.

Inherits: lib.ReportJobUserMeta

userMeta.summary Summary

string

Optional, one line user summary about a target job.

Max. length: 512

userMeta.description Description

string

Optional, longform description of a target job.

Job Creation Response JobCreateResponse

application/json

Response body returned on the successful creation of a new BLAST report job.

Inherits: object

Parameter	Type	Description
reportJobID* Report Job ID	string	Pattern: ^[\dA-Fa-f]{32}$ Min. length: 32 Max. length: 32

Parameter

Type

Description

reportJobID* Report Job ID

string

Pattern: ^[\dA-Fa-f]{32}$

Min. length: 32

Max. length: 32

Bad Request BadRequestError

application/json

Request could not be parsed or was otherwise unusable.

Discriminator: status

Discriminator value: bad-request

Inherits: error.Error

Parameter	Type	Description
status*	string	Enum: bad-request unauthorized forbidden not-found bad-method invalid-input server-error Inherits: error.ErrorType
message*	string

Response Body

{
  "status": "bad-request",
  "message": "malformed JSON"
}

Unauthorized UnauthorizedError

application/json

Unauthenticated client requested a resource that requires authentication.

Discriminator: status

Discriminator value: unauthorized

Inherits: error.Error

Parameter	Type	Description
status*	string	Enum: bad-request unauthorized forbidden not-found bad-method invalid-input server-error Inherits: error.ErrorType
message*	string

Response Body

{
  "status": "unauthorized",
  "message": "users must be logged in to access this resource"
}

Unprocessable Entity UnprocessableEntityError

application/json

The request payload or parameters are correctly structured but fail resource specific validation.

Discriminator: status

Discriminator value: invalid-input

Inherits: error.Error

Parameter	Type	Description
status*	string	Enum: bad-request unauthorized forbidden not-found bad-method invalid-input server-error Inherits: error.ErrorType
message*	string
errors*	object	Additional properties: Yes
errors.general*	array	Non-field specific errors.
errors.general[]	string
errors.byKey*	object	Field specific errors Additional properties: Yes
errors.byKey.//*	array
errors.byKey.//[]	string

Response Body

{
  "status": "invalid-input",
  "message": "JSON validation failed",
  "errors": {
    "general": [],
    "byKey": {
      "id": [
        "Given ID value does not point to an existing record."
      ]
    }
  }
}

Discriminator: status

Discriminator value: server-error

Inherits: error.Error

Parameter	Type	Description
status*	string	Enum: bad-request unauthorized forbidden not-found bad-method invalid-input server-error Inherits: error.ErrorType
message*	string
requestId*	string

Response Body

{
  "status": "server-error",
  "message": "Datastore connection lost",
  "requestId": "b296c3d9-4032-41b1-906e-c97ccfc447e3"
}

Deletes a target job from a user's job collection.

Parameters

Parameter	Type	Description
job-id Report Job ID	string	Pattern: ^[\dA-Fa-f]{32}$ Min. length: 32 Max. length: 32

Parameter

Type

Description

Path

job-id Report Job ID

string

Pattern: ^[\dA-Fa-f]{32}$

Min. length: 32

Max. length: 32

curl -X DELETE \
  undefined/jobs/{job-id}

Unauthorized UnauthorizedError

application/json

Unauthenticated client requested a resource that requires authentication.

Discriminator: status

Discriminator value: unauthorized

Inherits: error.Error

Parameter	Type	Description
status*	string	Enum: bad-request unauthorized forbidden not-found bad-method invalid-input server-error Inherits: error.ErrorType
message*	string

Response Body

{
  "status": "unauthorized",
  "message": "users must be logged in to access this resource"
}

Not Found NotFoundError

application/json

The requested resource was not found on this server.

Discriminator: status

Discriminator value: not-found

Inherits: error.Error

Parameter	Type	Description
status*	string	Enum: bad-request unauthorized forbidden not-found bad-method invalid-input server-error Inherits: error.ErrorType
message*	string

Response Body

{
  "status": "not-found",
  "message": "the requested resource could not be found"
}

Discriminator: status

Discriminator value: server-error

Inherits: error.Error

Parameter	Type	Description
status*	string	Enum: bad-request unauthorized forbidden not-found bad-method invalid-input server-error Inherits: error.ErrorType
message*	string
requestId*	string

Response Body

{
  "status": "server-error",
  "message": "Datastore connection lost",
  "requestId": "b296c3d9-4032-41b1-906e-c97ccfc447e3"
}

Lookup a job's details by the job's ID.

Parameters

Parameter	Type	Description
Path
job-id Report Job ID	string	Pattern: ^[\dA-Fa-f]{32}$ Min. length: 32 Max. length: 32
Query
save_job Save Job	boolean	Flag that specifies whether the requested job should be saved to the user's job collection. To maintain legacy job sharing behavior, this parameter defaults to `true`. Default value: true

curl -X GET \
  undefined/jobs/{job-id}?save_job=<value>

Report Job Details ReportJobDetails

application/json

Longform details about a report job that has been submitted.

Inherits: object

Parameter Type Description

reportJobID* Report Job ID

string

Pattern: ^[\dA-Fa-f]{32}$

Min. length: 32

Max. length: 32

queryJobID* Query Job ID

string

Pattern: ^[\dA-Fa-f]{32}$

Min. length: 32

Max. length: 32

status* Job Status

string

Enum:

queued
in-progress
complete
failed
expired

Inherits: lib.JobStatus

blastConfig*

object

Inherits: lib.BlastFormatConfig

blastConfig.formatType Format Type

string

Identifier	Description
pairwise	Pairwise
query-anchored-with-identities	Query-anchored showing identities
query-anchored-no-identities	Query-anchored no identities
flat-query-anchored-with-identities	Flat query-anchored showing identities
flat-query-anchored-no-identities	Flat query-anchored no identities
xml	BLAST XML
tabular	Tabular
tabular-with-comments	Tabular with comment lines
seqalign-text	Seqalign (Text ASN.1)
seqalign-binary	Seqalign (Binary ASN.1)
csv	Comma-separated values
asn1	BLAST archive (ASN.1)
seqalign-json	Seqalign (JSON)
multi-file-blast-json	Multiple-file BLAST JSON
multi-file-blast-xml2	Multiple-file BLAST XML2
single-file-blast-json	Single-file BLAST JSON
single-file-blast-xml2	Single-file BLAST XML2
sam	Sequence Alignment/Map (SAM)
organism-report	Organism Report

Default value: "pairwise"

Enum:

pairwise
query-anchored-with-identities
query-anchored-no-identities
flat-query-anchored-with-identities
flat-query-anchored-no-identities
xml
tabular
tabular-with-comments
seqalign-text
seqalign-binary
csv
asn1
seqalign-json
multi-file-blast-json
multi-file-blast-xml2
single-file-blast-json
single-file-blast-xml2
sam
organism-report

Inherits: lib.BlastOutFormat

blastConfig.formatFields Report Fields

array

Fields to include in the generated report.

Custom field selection is only valid for the following formatType values:

tabular
tabular-with-comments
csv
sam

For all other formatType values, including this field is an error.

blastConfig.formatFields[] Blast Report Field

string

Field	Meaning
qseqid	Query Seq-id
qgi	Query GI
qacc	Query accesion
qaccver	Query accesion.version
qlen	Query sequence length
sseqid	Subject Seq-id
sallseqid	All subject Seq-id(s), separated by a ';'
sgi	Subject GI
sallgi	All subject GIs
sacc	Subject accession
saccver	Subject accession.version
sallacc	All subject accessions
slen	Subject sequence length
qstart	Start of alignment in query
qend	End of alignment in query
sstart	Start of alignment in subject
send	End of alignment in subject
qseq	Aligned part of query sequence
sseq	Aligned part of subject sequence
evalue	Expect value
bitscore	Bit score
score	Raw score
length	Alignment length
pident	Percentage of identical matches
nident	Number of identical matches
mismatch	Number of mismatches
positive	Number of positive-scoring matches
gapopen	Number of gap openings
gaps	Total number of gaps
ppos	Percentage of positive-scoring matches
frames	Query and subject frames separated by a '/'
qframe	Query frame
sframe	Subject frame
btop	Blast traceback operations (BTOP)
staxid	Subject Taxonomy ID
ssciname	Subject Scientific Name
scomname	Subject Common Name
sblastname	Subject Blast Name
sskingdom	Subject Super Kingdom
staxids	unique Subject Taxonomy ID(s), separated by a ';' (in numerical order)
sscinames	unique Subject Scientific Name(s), separated by a ';'
scomnames	unique Subject Common Name(s), separated by a ';'
sblastnames	unique Subject Blast Name(s), separated by a ';' (in alphabetical order)
sskingdoms	unique Subject Super Kingdom(s), separated by a ';' (in alphabetical order)
stitle	Subject Title
salltitles	All Subject Title(s), separated by a '<>'
sstrand	Subject Strand
qcovs	Query Coverage Per Subject
qcovhsp	Query Coverage Per HSP
qcovus	Query Coverage Per Unique Subject (blastn only)
SQ	Include Sequence Data
SR	Subject as Reference Seq
std	'qaccver saccver pident length mismatch gapopen qstart qend sstart send evalue bitscore'

Enum:

qseqid
qgi
qacc
qaccver
qlen
sseqid
sallseqid
sgi
sallgi
sacc
saccver
sallacc
slen
qstart
qend
sstart
send
qseq
sseq
evalue
bitscore
score
length
pident
nident
mismatch
positive
gapopen
gaps
ppos
frames
qframe
sframe
btop
staxid
ssciname
scomname
sblastname
sskingdom
staxids
sscinames
scomnames
sblastnames
sskingdoms
stitle
salltitles
sstrand
qcovs
qcovhsp
qcovus
SQ
SR
std

Inherits: lib.BlastOutField

blastConfig.showGIs Show GIs

boolean

Show NCBI GIs in deflines?

blastConfig.numDescriptions Number of Descriptions

integer

Number of database sequences to show one-line descriptions for.

Only applicable for the following formatType values:

pairwise
query-anchored-with-identities
query-anchored-no-identities
flat-query-anchored-with-identities
flat-query-anchored-no-identities

Incompatible with maxTargetSequences.

Format: int

blastConfig.numAlignments Number of Alignments

integer

Number of database sequences to show alignments for.

Incompatible with maxTargetSequences.

Format: int

blastConfig.lineLength Line Length

integer

Line length for formatting alignments

Only applicable for the following formatType values:

pairwise
query-anchored-with-identities
query-anchored-no-identities
flat-query-anchored-with-identities
flat-query-anchored-no-identities

Incompatible with maxTargetSequences.

Min. value: 1

Format: int

blastConfig.sortHits Sort Hits

string

Sorting option for hits.

Only applicable for the following formatType values:

pairwise
query-anchored-with-identities
query-anchored-no-identities
flat-query-anchored-with-identities
flat-query-anchored-no-identities

Enum:

by-evalue
by-bit-score
by-total-score
by-percent-identity
by-query-coverage

Inherits: lib.BlastHitSorting

blastConfig.sortHSPs Sort HSPs

string

Sorting option for HSPs.

Only applicable for formatType value pairwise.

Enum:

by-hsp-evalue
by-hsp-score
by-hsp-query-start
by-hsp-percent-identity
by-hsp-subject-start

Inherits: lib.BlastHSPSorting

blastConfig.maxTargetSequences Max Target Sequences

integer

Maximum number of aligned sequences to keep.

Incompatible with:

numDescriptions
numAlignments

Min. value: 5

blastConfig.parseDefLines Parse Query Definition Lines

boolean

Should the query and subject defline(s) be parsed?

userMeta

object

User provided metadata about a report job.

Inherits: lib.ReportJobUserMeta

userMeta.summary Summary

string

Optional, one line user summary about a target job.

Max. length: 512

userMeta.description Description

string

Optional, longform description of a target job.

Unauthorized UnauthorizedError

application/json

Unauthenticated client requested a resource that requires authentication.

Discriminator: status

Discriminator value: unauthorized

Inherits: error.Error

Parameter	Type	Description
status*	string	Enum: bad-request unauthorized forbidden not-found bad-method invalid-input server-error Inherits: error.ErrorType
message*	string

Response Body

{
  "status": "unauthorized",
  "message": "users must be logged in to access this resource"
}

Not Found NotFoundError

application/json

The requested resource was not found on this server.

Discriminator: status

Discriminator value: not-found

Inherits: error.Error

Parameter	Type	Description
status*	string	Enum: bad-request unauthorized forbidden not-found bad-method invalid-input server-error Inherits: error.ErrorType
message*	string

Response Body

{
  "status": "not-found",
  "message": "the requested resource could not be found"
}

Discriminator: status

Discriminator value: server-error

Inherits: error.Error

Parameter	Type	Description
status*	string	Enum: bad-request unauthorized forbidden not-found bad-method invalid-input server-error Inherits: error.ErrorType
message*	string
requestId*	string

Response Body

{
  "status": "server-error",
  "message": "Datastore connection lost",
  "requestId": "b296c3d9-4032-41b1-906e-c97ccfc447e3"
}

Requeues a job to be executed if the job was previously expired.

Parameters

Parameter	Type	Description
job-id Report Job ID	string	Pattern: ^[\dA-Fa-f]{32}$ Min. length: 32 Max. length: 32

Parameter

Type

Description

Path

job-id Report Job ID

string

Pattern: ^[\dA-Fa-f]{32}$

Min. length: 32

Max. length: 32

curl -X POST \
  undefined/jobs/{job-id}

Unauthorized UnauthorizedError

application/json

Unauthenticated client requested a resource that requires authentication.

Discriminator: status

Discriminator value: unauthorized

Inherits: error.Error

Parameter	Type	Description
status*	string	Enum: bad-request unauthorized forbidden not-found bad-method invalid-input server-error Inherits: error.ErrorType
message*	string

Response Body

{
  "status": "unauthorized",
  "message": "users must be logged in to access this resource"
}

Forbidden ForbiddenError

application/json

Server understood the request but is refusing it.

Could be caused by incorrect instructions or an authenticated client requesting a resource or action that requires permissions that the client does not have assigned.

Discriminator: status

Discriminator value: forbidden

Inherits: error.Error

Parameter	Type	Description
status*	string	Enum: bad-request unauthorized forbidden not-found bad-method invalid-input server-error Inherits: error.ErrorType
message*	string

Response Body

{
  "status": "forbidden",
  "message": "the current user is not permitted to perform this action"
}

Not Found NotFoundError

application/json

The requested resource was not found on this server.

Discriminator: status

Discriminator value: not-found

Inherits: error.Error

Parameter	Type	Description
status*	string	Enum: bad-request unauthorized forbidden not-found bad-method invalid-input server-error Inherits: error.ErrorType
message*	string

Response Body

{
  "status": "not-found",
  "message": "the requested resource could not be found"
}

Discriminator: status

Discriminator value: server-error

Inherits: error.Error

Parameter	Type	Description
status*	string	Enum: bad-request unauthorized forbidden not-found bad-method invalid-input server-error Inherits: error.ErrorType
message*	string
requestId*	string

Response Body

{
  "status": "server-error",
  "message": "Datastore connection lost",
  "requestId": "b296c3d9-4032-41b1-906e-c97ccfc447e3"
}

Update's a user's job.

Parameters

Parameter	Type	Description
job-id Report Job ID	string	Pattern: ^[\dA-Fa-f]{32}$ Min. length: 32 Max. length: 32

Parameter

Type

Description

Path

job-id Report Job ID

string

Pattern: ^[\dA-Fa-f]{32}$

Min. length: 32

Max. length: 32

curl -X PATCH \
  -H "Content-type: application/json"
  -d @body.json \
  undefined/jobs/{job-id}

Report Job Update ReportJobPatchRequest

application/json

Request body sent to update an existing report job.

Inherits: object

Parameter	Type	Description
userMeta User Metadata	object	User provided metadata about a report job. Inherits: lib.ReportJobUserMeta
userMeta.summary Summary	string	Optional, one line user summary about a target job. Max. length: 512
userMeta.description Description	string	Optional, longform description of a target job.

Bad Request BadRequestError

application/json

Request could not be parsed or was otherwise unusable.

Discriminator: status

Discriminator value: bad-request

Inherits: error.Error

Parameter	Type	Description
status*	string	Enum: bad-request unauthorized forbidden not-found bad-method invalid-input server-error Inherits: error.ErrorType
message*	string

Response Body

{
  "status": "bad-request",
  "message": "malformed JSON"
}

Unauthorized UnauthorizedError

application/json

Unauthenticated client requested a resource that requires authentication.

Discriminator: status

Discriminator value: unauthorized

Inherits: error.Error

Parameter	Type	Description
status*	string	Enum: bad-request unauthorized forbidden not-found bad-method invalid-input server-error Inherits: error.ErrorType
message*	string

Response Body

{
  "status": "unauthorized",
  "message": "users must be logged in to access this resource"
}

Not Found NotFoundError

application/json

The requested resource was not found on this server.

Discriminator: status

Discriminator value: not-found

Inherits: error.Error

Parameter	Type	Description
status*	string	Enum: bad-request unauthorized forbidden not-found bad-method invalid-input server-error Inherits: error.ErrorType
message*	string

Response Body

{
  "status": "not-found",
  "message": "the requested resource could not be found"
}

Unprocessable Entity UnprocessableEntityError

application/json

The request payload or parameters are correctly structured but fail resource specific validation.

Discriminator: status

Discriminator value: invalid-input

Inherits: error.Error

Parameter	Type	Description
status*	string	Enum: bad-request unauthorized forbidden not-found bad-method invalid-input server-error Inherits: error.ErrorType
message*	string
errors*	object	Additional properties: Yes
errors.general*	array	Non-field specific errors.
errors.general[]	string
errors.byKey*	object	Field specific errors Additional properties: Yes
errors.byKey.//*	array
errors.byKey.//[]	string

Response Body

{
  "status": "invalid-input",
  "message": "JSON validation failed",
  "errors": {
    "general": [],
    "byKey": {
      "id": [
        "Given ID value does not point to an existing record."
      ]
    }
  }
}

Discriminator: status

Discriminator value: server-error

Inherits: error.Error

Parameter	Type	Description
status*	string	Enum: bad-request unauthorized forbidden not-found bad-method invalid-input server-error Inherits: error.ErrorType
message*	string
requestId*	string

Response Body

{
  "status": "server-error",
  "message": "Datastore connection lost",
  "requestId": "b296c3d9-4032-41b1-906e-c97ccfc447e3"
}

Lists the result files available for a given job.

This list will consist of the raw output(s) of the report job as well as a zip file named report.zip containing all of those outputs.

Parameters

Parameter	Type	Description
job-id Report Job ID	string	Pattern: ^[\dA-Fa-f]{32}$ Min. length: 32 Max. length: 32

Parameter

Type

Description

Path

job-id Report Job ID

string

Pattern: ^[\dA-Fa-f]{32}$

Min. length: 32

Max. length: 32

curl -X GET \
  undefined/jobs/{job-id}/files

Parameter	Type	Description
[] File Entry	object	List entry item for a file. Inherits: object
[].name* File Name	string	Name of the target file.
[].size* File Size	integer	Size of the file in bytes. Format: int64

Response Body

[
  {
    "name": "somefile1.txt",
    "size": 1023
  },
  {
    "name": "somefile2.json",
    "size": 58372
  },
  {
    "name": "report.zip",
    "size": 10234
  }
]

Unauthorized UnauthorizedError

application/json

Unauthenticated client requested a resource that requires authentication.

Discriminator: status

Discriminator value: unauthorized

Inherits: error.Error

Parameter	Type	Description
status*	string	Enum: bad-request unauthorized forbidden not-found bad-method invalid-input server-error Inherits: error.ErrorType
message*	string

Response Body

{
  "status": "unauthorized",
  "message": "users must be logged in to access this resource"
}

Forbidden ForbiddenError

application/json

Server understood the request but is refusing it.

Could be caused by incorrect instructions or an authenticated client requesting a resource or action that requires permissions that the client does not have assigned.

Discriminator: status

Discriminator value: forbidden

Inherits: error.Error

Parameter	Type	Description
status*	string	Enum: bad-request unauthorized forbidden not-found bad-method invalid-input server-error Inherits: error.ErrorType
message*	string

Response Body

{
  "status": "forbidden",
  "message": "the current user is not permitted to perform this action"
}

Not Found NotFoundError

application/json

The requested resource was not found on this server.

Discriminator: status

Discriminator value: not-found

Inherits: error.Error

Parameter	Type	Description
status*	string	Enum: bad-request unauthorized forbidden not-found bad-method invalid-input server-error Inherits: error.ErrorType
message*	string

Response Body

{
  "status": "not-found",
  "message": "the requested resource could not be found"
}

Discriminator: status

Discriminator value: server-error

Inherits: error.Error

Parameter	Type	Description
status*	string	Enum: bad-request unauthorized forbidden not-found bad-method invalid-input server-error Inherits: error.ErrorType
message*	string
requestId*	string

Response Body

{
  "status": "server-error",
  "message": "Datastore connection lost",
  "requestId": "b296c3d9-4032-41b1-906e-c97ccfc447e3"
}

Retrieves/downloads a target file from the report job output files.

Parameters

Parameter	Type	Description
Path
job-id Report Job ID	string	Pattern: ^[\dA-Fa-f]{32}$ Min. length: 32 Max. length: 32
filename*	string
Query
download Download	boolean	When set to true, indicates that the service should mark the returned file as an attachment using the `Content-Disposition` header to cause the file to be downloaded by the browser rather than rendered.

curl -X GET \
  undefined/jobs/{job-id}/files/{filename}?download=<value>

Parameter	Type	Description
Content-Disposition	string	Present if the `download` query parameter was sent in with the request.

Unauthorized UnauthorizedError

application/json

Unauthenticated client requested a resource that requires authentication.

Discriminator: status

Discriminator value: unauthorized

Inherits: error.Error

Parameter	Type	Description
status*	string	Enum: bad-request unauthorized forbidden not-found bad-method invalid-input server-error Inherits: error.ErrorType
message*	string

Response Body

{
  "status": "unauthorized",
  "message": "users must be logged in to access this resource"
}

Forbidden ForbiddenError

application/json

Server understood the request but is refusing it.

Could be caused by incorrect instructions or an authenticated client requesting a resource or action that requires permissions that the client does not have assigned.

Discriminator: status

Discriminator value: forbidden

Inherits: error.Error

Parameter	Type	Description
status*	string	Enum: bad-request unauthorized forbidden not-found bad-method invalid-input server-error Inherits: error.ErrorType
message*	string

Response Body

{
  "status": "forbidden",
  "message": "the current user is not permitted to perform this action"
}

Not Found NotFoundError

application/json

The requested resource was not found on this server.

Discriminator: status

Discriminator value: not-found

Inherits: error.Error

Parameter	Type	Description
status*	string	Enum: bad-request unauthorized forbidden not-found bad-method invalid-input server-error Inherits: error.ErrorType
message*	string

Response Body

{
  "status": "not-found",
  "message": "the requested resource could not be found"
}

Discriminator: status

Discriminator value: server-error

Inherits: error.Error

Parameter	Type	Description
status*	string	Enum: bad-request unauthorized forbidden not-found bad-method invalid-input server-error Inherits: error.ErrorType
message*	string
requestId*	string

Response Body

{
  "status": "server-error",
  "message": "Datastore connection lost",
  "requestId": "b296c3d9-4032-41b1-906e-c97ccfc447e3"
}

Returns the stderr output for the blast tool execution for this job.

This output may be empty.

Parameters

Parameter	Type	Description
Path
job-id Report Job ID	string	Pattern: ^[\dA-Fa-f]{32}$ Min. length: 32 Max. length: 32
Query
download Download	boolean	When set to true, indicates that the service should mark the returned file as an attachment using the `Content-Disposition` header to cause the file to be downloaded by the browser rather than rendered.

curl -X GET \
  undefined/jobs/{job-id}/stderr?download=<value>

Parameter	Type	Description
Content-Disposition	string	Present if the `download` query parameter was sent in with the request.

Response Body

FASTA-Reader: Ignoring invalid residues at position(s): On line 1: 1, 62-63
FASTA-Reader: Ignoring invalid residues at position(s): On line 2: 44-46
FASTA-Reader: Ignoring invalid residues at position(s): On line 3: 27-29
FASTA-Reader: Ignoring invalid residues at position(s): On line 4: 10-12, 73-75
FASTA-Reader: Ignoring invalid residues at position(s): On line 5: 56-58
FASTA-Reader: Ignoring invalid residues at position(s): On line 6: 39-41

Unauthorized UnauthorizedError

application/json

Unauthenticated client requested a resource that requires authentication.

Discriminator: status

Discriminator value: unauthorized

Inherits: error.Error

Parameter	Type	Description
status*	string	Enum: bad-request unauthorized forbidden not-found bad-method invalid-input server-error Inherits: error.ErrorType
message*	string

Response Body

{
  "status": "unauthorized",
  "message": "users must be logged in to access this resource"
}

Forbidden ForbiddenError

application/json

Server understood the request but is refusing it.

Could be caused by incorrect instructions or an authenticated client requesting a resource or action that requires permissions that the client does not have assigned.

Discriminator: status

Discriminator value: forbidden

Inherits: error.Error

Parameter	Type	Description
status*	string	Enum: bad-request unauthorized forbidden not-found bad-method invalid-input server-error Inherits: error.ErrorType
message*	string

Response Body

{
  "status": "forbidden",
  "message": "the current user is not permitted to perform this action"
}

Not Found NotFoundError

application/json

The requested resource was not found on this server.

Discriminator: status

Discriminator value: not-found

Inherits: error.Error

Parameter	Type	Description
status*	string	Enum: bad-request unauthorized forbidden not-found bad-method invalid-input server-error Inherits: error.ErrorType
message*	string

Response Body

{
  "status": "not-found",
  "message": "the requested resource could not be found"
}

Discriminator: status

Discriminator value: server-error

Inherits: error.Error

Parameter	Type	Description
status*	string	Enum: bad-request unauthorized forbidden not-found bad-method invalid-input server-error Inherits: error.ErrorType
message*	string
requestId*	string

Response Body

{
  "status": "server-error",
  "message": "Datastore connection lost",
  "requestId": "b296c3d9-4032-41b1-906e-c97ccfc447e3"
}

Lookup the statuses for the list of job IDs posted.

The response will be a mapping whose keys are the posted job IDs and whose values are the status of the job represented by the associated ID.

If a job ID in the input list does not appear to be a real/valid job ID, the ID will be omitted from the response object.

Each status value will be a valid JobStatus enum item, meaning they will each be one of:

"queued"
"in-progress"
"complete"
"failed"
"expired"

curl -X POST \
  -H "Content-type: application/json"
  -d @body.json \
  undefined/statuses

Parameter

Type

Description

[]

string

Pattern: ^[\dA-Fa-f]{32}$

Min. length: 32

Max. length: 32

Request Body

[
  "dd6060e5367622e574ffb38f32bfa049",
  "77542f92d9e68ea80eff4852ecc41fa4",
  "29e07b0b80181222ad33cbc8f679d672",
  "748ba381dd81bb8de615319837ffa350",
  "f4757ea84c455b04a1d307d4ac33049d"
]

Bulk Job Status Response JobBulkStatusResponse

application/json

Returns a mapping of job-id to status for each of the valid job IDs that appeared in the original bulk status request.

Additional properties: Yes

Inherits: object

Parameter	Type	Description
/^[\dA-Fa-f]{32}$/*	string	Enum: queued in-progress complete failed expired Inherits: lib.JobStatus

Response Body

{
  "dd6060e5367622e574ffb38f32bfa049": "queued",
  "29e07b0b80181222ad33cbc8f679d672": "complete",
  "748ba381dd81bb8de615319837ffa350": "in-progress",
  "f4757ea84c455b04a1d307d4ac33049d": "expired"
}

Discriminator: status

Discriminator value: server-error

Inherits: error.Error

Parameter	Type	Description
status*	string	Enum: bad-request unauthorized forbidden not-found bad-method invalid-input server-error Inherits: error.ErrorType
message*	string
requestId*	string

Response Body

{
  "status": "server-error",
  "message": "Datastore connection lost",
  "requestId": "b296c3d9-4032-41b1-906e-c97ccfc447e3"
}

A request to transfer ownership of jobs from a guest user to a logged in user, linking the logged in user to the jobs they created before they logged in.

curl -X POST \
  -H "Content-type: application/json"
  -d @body.json \
  undefined/link-guest

Guest to User Job Transfer Request GuestJobTransferRequest

application/json

Request body for a request to transfer ownership of jobs from a guest user to a logged in user.

Inherits: object

Parameter	Type	Description
guestID* Guest ID	integer	ID assigned to the user before they were logged in. Format: int64

Bad Request BadRequestError

application/json

Request could not be parsed or was otherwise unusable.

Discriminator: status

Discriminator value: bad-request

Inherits: error.Error

Parameter	Type	Description
status*	string	Enum: bad-request unauthorized forbidden not-found bad-method invalid-input server-error Inherits: error.ErrorType
message*	string

Response Body

{
  "status": "bad-request",
  "message": "malformed JSON"
}

Unauthorized UnauthorizedError

application/json

Unauthenticated client requested a resource that requires authentication.

Discriminator: status

Discriminator value: unauthorized

Inherits: error.Error

Parameter	Type	Description
status*	string	Enum: bad-request unauthorized forbidden not-found bad-method invalid-input server-error Inherits: error.ErrorType
message*	string

Response Body

{
  "status": "unauthorized",
  "message": "users must be logged in to access this resource"
}

Forbidden ForbiddenError

application/json

Server understood the request but is refusing it.

Could be caused by incorrect instructions or an authenticated client requesting a resource or action that requires permissions that the client does not have assigned.

Discriminator: status

Discriminator value: forbidden

Inherits: error.Error

Parameter	Type	Description
status*	string	Enum: bad-request unauthorized forbidden not-found bad-method invalid-input server-error Inherits: error.ErrorType
message*	string

Response Body

{
  "status": "forbidden",
  "message": "the current user is not permitted to perform this action"
}

Discriminator: status

Discriminator value: server-error

Inherits: error.Error

Parameter	Type	Description
status*	string	Enum: bad-request unauthorized forbidden not-found bad-method invalid-input server-error Inherits: error.ErrorType
message*	string
requestId*	string

Response Body

{
  "status": "server-error",
  "message": "Datastore connection lost",
  "requestId": "b296c3d9-4032-41b1-906e-c97ccfc447e3"
}

Deletes all jobs in the job cache. This endpoint is to be used during site releases to clear any old data that may have been invalidated by the changes to the underlying site data.

Headers

Parameter	Type	Description
Admin-Token*	string

curl -X DELETE \
  -H "Admin-Token: <value>" \
  undefined/maintenance/cache

Unauthorized UnauthorizedError

application/json

Unauthenticated client requested a resource that requires authentication.

Discriminator: status

Discriminator value: unauthorized

Inherits: error.Error

Parameter	Type	Description
status*	string	Enum: bad-request unauthorized forbidden not-found bad-method invalid-input server-error Inherits: error.ErrorType
message*	string

Response Body

{
  "status": "unauthorized",
  "message": "users must be logged in to access this resource"
}

Discriminator: status

Discriminator value: server-error

Inherits: error.Error

Parameter	Type	Description
status*	string	Enum: bad-request unauthorized forbidden not-found bad-method invalid-input server-error Inherits: error.ErrorType
message*	string
requestId*	string

Response Body

{
  "status": "server-error",
  "message": "Datastore connection lost",
  "requestId": "b296c3d9-4032-41b1-906e-c97ccfc447e3"
}

Parameters

Parameter

Type

Description

Path

job-id Job ID

string

Pattern: ^[\dA-Fa-f]{32}$

Min. length: 32

Max. length: 32

Headers

Parameter	Type	Description
Admin-Token*	string

curl -X DELETE \
  -H "Admin-Token: <value>" \
  undefined/maintenance/cache/{job-id}

Unauthorized UnauthorizedError

application/json

Unauthenticated client requested a resource that requires authentication.

Discriminator: status

Discriminator value: unauthorized

Inherits: error.Error

Parameter	Type	Description
status*	string	Enum: bad-request unauthorized forbidden not-found bad-method invalid-input server-error Inherits: error.ErrorType
message*	string

Response Body

{
  "status": "unauthorized",
  "message": "users must be logged in to access this resource"
}

Discriminator: status

Discriminator value: server-error

Inherits: error.Error

Parameter	Type	Description
status*	string	Enum: bad-request unauthorized forbidden not-found bad-method invalid-input server-error Inherits: error.ErrorType
message*	string
requestId*	string

Response Body

{
  "status": "server-error",
  "message": "Datastore connection lost",
  "requestId": "b296c3d9-4032-41b1-906e-c97ccfc447e3"
}

Lists job IDs for jobs owned by the current campus that are in the "failed" status.

Headers

Parameter	Type	Description
Admin-Token*	string

curl -X GET \
  -H "Admin-Token: <value>" \
  undefined/maintenance/broken-jobs

Parameter	Type	Description
[]	object	Inherits: object
[].reportJobID* Report Job ID	string	Hash ID of the report job. Pattern: ^[\dA-Fa-f]{32}$ Min. length: 32 Max. length: 32
[].rawConfig*	any
[].createdOn* Created On	datetime	Job creation timestamp.
[].failedOn* Failed On	datetime	Job failure timestamp.

Unauthorized UnauthorizedError

application/json

Unauthenticated client requested a resource that requires authentication.

Discriminator: status

Discriminator value: unauthorized

Inherits: error.Error

Parameter	Type	Description
status*	string	Enum: bad-request unauthorized forbidden not-found bad-method invalid-input server-error Inherits: error.ErrorType
message*	string

Response Body

{
  "status": "unauthorized",
  "message": "users must be logged in to access this resource"
}

Discriminator: status

Discriminator value: server-error

Inherits: error.Error

Parameter	Type	Description
status*	string	Enum: bad-request unauthorized forbidden not-found bad-method invalid-input server-error Inherits: error.ErrorType
message*	string
requestId*	string

Response Body

{
  "status": "server-error",
  "message": "Datastore connection lost",
  "requestId": "b296c3d9-4032-41b1-906e-c97ccfc447e3"
}

Renders the API documentation for this service.

curl -X GET \
  undefined/api

Prints information about the overall service health.

curl -X GET \
  undefined/health

HealthResponse HealthResponse

application/json

Health details about the service

Inherits: object

Parameter	Type	Description
status*	string	Status describes the overall service state. A status of "healthy" indicates that everything is running smoothly and all service dependencies are reachable and online. A status of "unhealthy" indicates that something is wrong with either this service or one or more of it's dependency services. Enum: healthy unhealthy
dependencies*	array	A list of external services that this service depends on and some details about them.
dependencies[]	object	Inherits: DependencyStatus
dependencies[].name*	string	Name of the external depdendency.
dependencies[].reachable*	boolean	Whether or not the external service is reachable.
dependencies[].online*	string	Whether or not the external service is online and available for requests. Enum: yes unknown no
info*	object	Additional properties: Yes
info.threads*	integer	Min. value: 1
info.uptime*	string
info.uptimeMillis*	integer	Min. value: 1 Format: int64

Discriminator: status

Discriminator value: server-error

Inherits: error.Error

Parameter	Type	Description
status*	string	Enum: bad-request unauthorized forbidden not-found bad-method invalid-input server-error Inherits: error.ErrorType
message*	string
requestId*	string

Response Body

{
  "status": "server-error",
  "message": "Datastore connection lost",
  "requestId": "b296c3d9-4032-41b1-906e-c97ccfc447e3"
}

Prometheus metrics for the service.

curl -X GET \
  undefined/metrics

Security Schemes

Types

Request body for a request to transfer ownership of jobs from a guest user to a logged in user.

Inherits: object

Model

Parameter	Type	Description
guestID* Guest ID	integer	ID assigned to the user before they were logged in. Format: int64

Request body sent to start a new report job.

Inherits: object

Model

Parameter Type Description

queryJobID*

string

Pattern: ^[\dA-Fa-f]{32}$

Min. length: 32

Max. length: 32

blastConfig

object

Default value: {"formatType":"pairwise"}

Inherits: lib.BlastFormatConfig

blastConfig.formatType Format Type

string

Identifier	Description
pairwise	Pairwise
query-anchored-with-identities	Query-anchored showing identities
query-anchored-no-identities	Query-anchored no identities
flat-query-anchored-with-identities	Flat query-anchored showing identities
flat-query-anchored-no-identities	Flat query-anchored no identities
xml	BLAST XML
tabular	Tabular
tabular-with-comments	Tabular with comment lines
seqalign-text	Seqalign (Text ASN.1)
seqalign-binary	Seqalign (Binary ASN.1)
csv	Comma-separated values
asn1	BLAST archive (ASN.1)
seqalign-json	Seqalign (JSON)
multi-file-blast-json	Multiple-file BLAST JSON
multi-file-blast-xml2	Multiple-file BLAST XML2
single-file-blast-json	Single-file BLAST JSON
single-file-blast-xml2	Single-file BLAST XML2
sam	Sequence Alignment/Map (SAM)
organism-report	Organism Report

Default value: "pairwise"

Enum:

pairwise
query-anchored-with-identities
query-anchored-no-identities
flat-query-anchored-with-identities
flat-query-anchored-no-identities
xml
tabular
tabular-with-comments
seqalign-text
seqalign-binary
csv
asn1
seqalign-json
multi-file-blast-json
multi-file-blast-xml2
single-file-blast-json
single-file-blast-xml2
sam
organism-report

Inherits: lib.BlastOutFormat

blastConfig.formatFields Report Fields

array

Fields to include in the generated report.

Custom field selection is only valid for the following formatType values:

tabular
tabular-with-comments
csv
sam

For all other formatType values, including this field is an error.

blastConfig.formatFields[] Blast Report Field

string

Field	Meaning
qseqid	Query Seq-id
qgi	Query GI
qacc	Query accesion
qaccver	Query accesion.version
qlen	Query sequence length
sseqid	Subject Seq-id
sallseqid	All subject Seq-id(s), separated by a ';'
sgi	Subject GI
sallgi	All subject GIs
sacc	Subject accession
saccver	Subject accession.version
sallacc	All subject accessions
slen	Subject sequence length
qstart	Start of alignment in query
qend	End of alignment in query
sstart	Start of alignment in subject
send	End of alignment in subject
qseq	Aligned part of query sequence
sseq	Aligned part of subject sequence
evalue	Expect value
bitscore	Bit score
score	Raw score
length	Alignment length
pident	Percentage of identical matches
nident	Number of identical matches
mismatch	Number of mismatches
positive	Number of positive-scoring matches
gapopen	Number of gap openings
gaps	Total number of gaps
ppos	Percentage of positive-scoring matches
frames	Query and subject frames separated by a '/'
qframe	Query frame
sframe	Subject frame
btop	Blast traceback operations (BTOP)
staxid	Subject Taxonomy ID
ssciname	Subject Scientific Name
scomname	Subject Common Name
sblastname	Subject Blast Name
sskingdom	Subject Super Kingdom
staxids	unique Subject Taxonomy ID(s), separated by a ';' (in numerical order)
sscinames	unique Subject Scientific Name(s), separated by a ';'
scomnames	unique Subject Common Name(s), separated by a ';'
sblastnames	unique Subject Blast Name(s), separated by a ';' (in alphabetical order)
sskingdoms	unique Subject Super Kingdom(s), separated by a ';' (in alphabetical order)
stitle	Subject Title
salltitles	All Subject Title(s), separated by a '<>'
sstrand	Subject Strand
qcovs	Query Coverage Per Subject
qcovhsp	Query Coverage Per HSP
qcovus	Query Coverage Per Unique Subject (blastn only)
SQ	Include Sequence Data
SR	Subject as Reference Seq
std	'qaccver saccver pident length mismatch gapopen qstart qend sstart send evalue bitscore'

Enum:

qseqid
qgi
qacc
qaccver
qlen
sseqid
sallseqid
sgi
sallgi
sacc
saccver
sallacc
slen
qstart
qend
sstart
send
qseq
sseq
evalue
bitscore
score
length
pident
nident
mismatch
positive
gapopen
gaps
ppos
frames
qframe
sframe
btop
staxid
ssciname
scomname
sblastname
sskingdom
staxids
sscinames
scomnames
sblastnames
sskingdoms
stitle
salltitles
sstrand
qcovs
qcovhsp
qcovus
SQ
SR
std

Inherits: lib.BlastOutField

blastConfig.showGIs Show GIs

boolean

Show NCBI GIs in deflines?

blastConfig.numDescriptions Number of Descriptions

integer

Number of database sequences to show one-line descriptions for.

Only applicable for the following formatType values:

pairwise
query-anchored-with-identities
query-anchored-no-identities
flat-query-anchored-with-identities
flat-query-anchored-no-identities

Incompatible with maxTargetSequences.

Format: int

blastConfig.numAlignments Number of Alignments

integer

Number of database sequences to show alignments for.

Incompatible with maxTargetSequences.

Format: int

blastConfig.lineLength Line Length

integer

Line length for formatting alignments

Only applicable for the following formatType values:

pairwise
query-anchored-with-identities
query-anchored-no-identities
flat-query-anchored-with-identities
flat-query-anchored-no-identities

Incompatible with maxTargetSequences.

Min. value: 1

Format: int

blastConfig.sortHits Sort Hits

string

Sorting option for hits.

Only applicable for the following formatType values:

pairwise
query-anchored-with-identities
query-anchored-no-identities
flat-query-anchored-with-identities
flat-query-anchored-no-identities

Enum:

by-evalue
by-bit-score
by-total-score
by-percent-identity
by-query-coverage

Inherits: lib.BlastHitSorting

blastConfig.sortHSPs Sort HSPs

string

Sorting option for HSPs.

Only applicable for formatType value pairwise.

Enum:

by-hsp-evalue
by-hsp-score
by-hsp-query-start
by-hsp-percent-identity
by-hsp-subject-start

Inherits: lib.BlastHSPSorting

blastConfig.maxTargetSequences Max Target Sequences

integer

Maximum number of aligned sequences to keep.

Incompatible with:

numDescriptions
numAlignments

Min. value: 5

blastConfig.parseDefLines Parse Query Definition Lines

boolean

Should the query and subject defline(s) be parsed?

addToUserCollection

boolean

Default value: true

userMeta

object

User provided metadata about a report job.

Inherits: lib.ReportJobUserMeta

userMeta.summary Summary

string

Optional, one line user summary about a target job.

Max. length: 512

userMeta.description Description

string

Optional, longform description of a target job.

Request body sent to update an existing report job.

Inherits: object

Model

Parameter	Type	Description
userMeta User Metadata	object	User provided metadata about a report job. Inherits: lib.ReportJobUserMeta
userMeta.summary Summary	string	Optional, one line user summary about a target job. Max. length: 512
userMeta.description Description	string	Optional, longform description of a target job.

Longform details about a report job that has been submitted.

Inherits: object

Model

Parameter Type Description

reportJobID* Report Job ID

string

Pattern: ^[\dA-Fa-f]{32}$

Min. length: 32

Max. length: 32

queryJobID* Query Job ID

string

Pattern: ^[\dA-Fa-f]{32}$

Min. length: 32

Max. length: 32

status* Job Status

string

Enum:

queued
in-progress
complete
failed
expired

Inherits: lib.JobStatus

blastConfig*

object

Inherits: lib.BlastFormatConfig

blastConfig.formatType Format Type

string

Identifier	Description
pairwise	Pairwise
query-anchored-with-identities	Query-anchored showing identities
query-anchored-no-identities	Query-anchored no identities
flat-query-anchored-with-identities	Flat query-anchored showing identities
flat-query-anchored-no-identities	Flat query-anchored no identities
xml	BLAST XML
tabular	Tabular
tabular-with-comments	Tabular with comment lines
seqalign-text	Seqalign (Text ASN.1)
seqalign-binary	Seqalign (Binary ASN.1)
csv	Comma-separated values
asn1	BLAST archive (ASN.1)
seqalign-json	Seqalign (JSON)
multi-file-blast-json	Multiple-file BLAST JSON
multi-file-blast-xml2	Multiple-file BLAST XML2
single-file-blast-json	Single-file BLAST JSON
single-file-blast-xml2	Single-file BLAST XML2
sam	Sequence Alignment/Map (SAM)
organism-report	Organism Report

Default value: "pairwise"

Enum:

pairwise
query-anchored-with-identities
query-anchored-no-identities
flat-query-anchored-with-identities
flat-query-anchored-no-identities
xml
tabular
tabular-with-comments
seqalign-text
seqalign-binary
csv
asn1
seqalign-json
multi-file-blast-json
multi-file-blast-xml2
single-file-blast-json
single-file-blast-xml2
sam
organism-report

Inherits: lib.BlastOutFormat

blastConfig.formatFields Report Fields

array

Fields to include in the generated report.

Custom field selection is only valid for the following formatType values:

tabular
tabular-with-comments
csv
sam

For all other formatType values, including this field is an error.

blastConfig.formatFields[] Blast Report Field

string

Field	Meaning
qseqid	Query Seq-id
qgi	Query GI
qacc	Query accesion
qaccver	Query accesion.version
qlen	Query sequence length
sseqid	Subject Seq-id
sallseqid	All subject Seq-id(s), separated by a ';'
sgi	Subject GI
sallgi	All subject GIs
sacc	Subject accession
saccver	Subject accession.version
sallacc	All subject accessions
slen	Subject sequence length
qstart	Start of alignment in query
qend	End of alignment in query
sstart	Start of alignment in subject
send	End of alignment in subject
qseq	Aligned part of query sequence
sseq	Aligned part of subject sequence
evalue	Expect value
bitscore	Bit score
score	Raw score
length	Alignment length
pident	Percentage of identical matches
nident	Number of identical matches
mismatch	Number of mismatches
positive	Number of positive-scoring matches
gapopen	Number of gap openings
gaps	Total number of gaps
ppos	Percentage of positive-scoring matches
frames	Query and subject frames separated by a '/'
qframe	Query frame
sframe	Subject frame
btop	Blast traceback operations (BTOP)
staxid	Subject Taxonomy ID
ssciname	Subject Scientific Name
scomname	Subject Common Name
sblastname	Subject Blast Name
sskingdom	Subject Super Kingdom
staxids	unique Subject Taxonomy ID(s), separated by a ';' (in numerical order)
sscinames	unique Subject Scientific Name(s), separated by a ';'
scomnames	unique Subject Common Name(s), separated by a ';'
sblastnames	unique Subject Blast Name(s), separated by a ';' (in alphabetical order)
sskingdoms	unique Subject Super Kingdom(s), separated by a ';' (in alphabetical order)
stitle	Subject Title
salltitles	All Subject Title(s), separated by a '<>'
sstrand	Subject Strand
qcovs	Query Coverage Per Subject
qcovhsp	Query Coverage Per HSP
qcovus	Query Coverage Per Unique Subject (blastn only)
SQ	Include Sequence Data
SR	Subject as Reference Seq
std	'qaccver saccver pident length mismatch gapopen qstart qend sstart send evalue bitscore'

Enum:

qseqid
qgi
qacc
qaccver
qlen
sseqid
sallseqid
sgi
sallgi
sacc
saccver
sallacc
slen
qstart
qend
sstart
send
qseq
sseq
evalue
bitscore
score
length
pident
nident
mismatch
positive
gapopen
gaps
ppos
frames
qframe
sframe
btop
staxid
ssciname
scomname
sblastname
sskingdom
staxids
sscinames
scomnames
sblastnames
sskingdoms
stitle
salltitles
sstrand
qcovs
qcovhsp
qcovus
SQ
SR
std

Inherits: lib.BlastOutField

blastConfig.showGIs Show GIs

boolean

Show NCBI GIs in deflines?

blastConfig.numDescriptions Number of Descriptions

integer

Number of database sequences to show one-line descriptions for.

Only applicable for the following formatType values:

pairwise
query-anchored-with-identities
query-anchored-no-identities
flat-query-anchored-with-identities
flat-query-anchored-no-identities

Incompatible with maxTargetSequences.

Format: int

blastConfig.numAlignments Number of Alignments

integer

Number of database sequences to show alignments for.

Incompatible with maxTargetSequences.

Format: int

blastConfig.lineLength Line Length

integer

Line length for formatting alignments

Only applicable for the following formatType values:

pairwise
query-anchored-with-identities
query-anchored-no-identities
flat-query-anchored-with-identities
flat-query-anchored-no-identities

Incompatible with maxTargetSequences.

Min. value: 1

Format: int

blastConfig.sortHits Sort Hits

string

Sorting option for hits.

Only applicable for the following formatType values:

pairwise
query-anchored-with-identities
query-anchored-no-identities
flat-query-anchored-with-identities
flat-query-anchored-no-identities

Enum:

by-evalue
by-bit-score
by-total-score
by-percent-identity
by-query-coverage

Inherits: lib.BlastHitSorting

blastConfig.sortHSPs Sort HSPs

string

Sorting option for HSPs.

Only applicable for formatType value pairwise.

Enum:

by-hsp-evalue
by-hsp-score
by-hsp-query-start
by-hsp-percent-identity
by-hsp-subject-start

Inherits: lib.BlastHSPSorting

blastConfig.maxTargetSequences Max Target Sequences

integer

Maximum number of aligned sequences to keep.

Incompatible with:

numDescriptions
numAlignments

Min. value: 5

blastConfig.parseDefLines Parse Query Definition Lines

boolean

Should the query and subject defline(s) be parsed?

userMeta

object

User provided metadata about a report job.

Inherits: lib.ReportJobUserMeta

userMeta.summary Summary

string

Optional, one line user summary about a target job.

Max. length: 512

userMeta.description Description

string

Optional, longform description of a target job.

Short-form details about a report job that has been submitted. This object is intended to appear in a list of similar objects for report job list endpoints.

Inherits: object

Model

Parameter	Type	Description
reportJobID* Report Job ID	string	Hash ID of the report job. Pattern: ^[\dA-Fa-f]{32}$ Min. length: 32 Max. length: 32
queryJobID* Query Job ID	string	Hash ID of the source query job. Pattern: ^[\dA-Fa-f]{32}$ Min. length: 32 Max. length: 32
status* Job Status	string	Current status of the represented report job. Enum: queued in-progress complete failed expired Inherits: lib.JobStatus
userMeta Job Meta	object	User provided metadata about the represented report job. Inherits: lib.ReportJobUserMeta
userMeta.summary Summary	string	Optional, one line user summary about a target job. Max. length: 512
userMeta.description Description	string	Optional, longform description of a target job.

User provided metadata about a report job.

Inherits: object

Model

Parameter	Type	Description
summary Summary	string	Optional, one line user summary about a target job. Max. length: 512
description Description	string	Optional, longform description of a target job.

List entry item for a file.

Inherits: object

Model

Parameter	Type	Description
name* File Name	string	Name of the target file.
size* File Size	integer	Size of the file in bytes. Format: int64

Returns a mapping of job-id to status for each of the valid job IDs that appeared in the original bulk status request.

Additional properties: Yes

Inherits: object

Model

Parameter	Type	Description
/^[\dA-Fa-f]{32}$/*	string	Enum: queued in-progress complete failed expired Inherits: lib.JobStatus

Enum:

queued
in-progress
complete
failed
expired

Inherits: string

Response body returned on the successful creation of a new BLAST report job.

Inherits: object

Model

Parameter

Type

Description

reportJobID* Report Job ID

string

Pattern: ^[\dA-Fa-f]{32}$

Min. length: 32

Max. length: 32

Inherits: object

Model

Parameter	Type	Description
reportJobID* Report Job ID	string	Hash ID of the report job. Pattern: ^[\dA-Fa-f]{32}$ Min. length: 32 Max. length: 32
rawConfig*	any
createdOn* Created On	datetime	Job creation timestamp.
failedOn* Failed On	datetime	Job failure timestamp.

Inherits: object

Model

Parameter Type Description

formatType Format Type

string

Identifier	Description
pairwise	Pairwise
query-anchored-with-identities	Query-anchored showing identities
query-anchored-no-identities	Query-anchored no identities
flat-query-anchored-with-identities	Flat query-anchored showing identities
flat-query-anchored-no-identities	Flat query-anchored no identities
xml	BLAST XML
tabular	Tabular
tabular-with-comments	Tabular with comment lines
seqalign-text	Seqalign (Text ASN.1)
seqalign-binary	Seqalign (Binary ASN.1)
csv	Comma-separated values
asn1	BLAST archive (ASN.1)
seqalign-json	Seqalign (JSON)
multi-file-blast-json	Multiple-file BLAST JSON
multi-file-blast-xml2	Multiple-file BLAST XML2
single-file-blast-json	Single-file BLAST JSON
single-file-blast-xml2	Single-file BLAST XML2
sam	Sequence Alignment/Map (SAM)
organism-report	Organism Report

Default value: "pairwise"

Enum:

pairwise
query-anchored-with-identities
query-anchored-no-identities
flat-query-anchored-with-identities
flat-query-anchored-no-identities
xml
tabular
tabular-with-comments
seqalign-text
seqalign-binary
csv
asn1
seqalign-json
multi-file-blast-json
multi-file-blast-xml2
single-file-blast-json
single-file-blast-xml2
sam
organism-report

Inherits: lib.BlastOutFormat

formatFields Report Fields

array

Fields to include in the generated report.

Custom field selection is only valid for the following formatType values:

tabular
tabular-with-comments
csv
sam

For all other formatType values, including this field is an error.

formatFields[] Blast Report Field

string

Field	Meaning
qseqid	Query Seq-id
qgi	Query GI
qacc	Query accesion
qaccver	Query accesion.version
qlen	Query sequence length
sseqid	Subject Seq-id
sallseqid	All subject Seq-id(s), separated by a ';'
sgi	Subject GI
sallgi	All subject GIs
sacc	Subject accession
saccver	Subject accession.version
sallacc	All subject accessions
slen	Subject sequence length
qstart	Start of alignment in query
qend	End of alignment in query
sstart	Start of alignment in subject
send	End of alignment in subject
qseq	Aligned part of query sequence
sseq	Aligned part of subject sequence
evalue	Expect value
bitscore	Bit score
score	Raw score
length	Alignment length
pident	Percentage of identical matches
nident	Number of identical matches
mismatch	Number of mismatches
positive	Number of positive-scoring matches
gapopen	Number of gap openings
gaps	Total number of gaps
ppos	Percentage of positive-scoring matches
frames	Query and subject frames separated by a '/'
qframe	Query frame
sframe	Subject frame
btop	Blast traceback operations (BTOP)
staxid	Subject Taxonomy ID
ssciname	Subject Scientific Name
scomname	Subject Common Name
sblastname	Subject Blast Name
sskingdom	Subject Super Kingdom
staxids	unique Subject Taxonomy ID(s), separated by a ';' (in numerical order)
sscinames	unique Subject Scientific Name(s), separated by a ';'
scomnames	unique Subject Common Name(s), separated by a ';'
sblastnames	unique Subject Blast Name(s), separated by a ';' (in alphabetical order)
sskingdoms	unique Subject Super Kingdom(s), separated by a ';' (in alphabetical order)
stitle	Subject Title
salltitles	All Subject Title(s), separated by a '<>'
sstrand	Subject Strand
qcovs	Query Coverage Per Subject
qcovhsp	Query Coverage Per HSP
qcovus	Query Coverage Per Unique Subject (blastn only)
SQ	Include Sequence Data
SR	Subject as Reference Seq
std	'qaccver saccver pident length mismatch gapopen qstart qend sstart send evalue bitscore'

Enum:

qseqid
qgi
qacc
qaccver
qlen
sseqid
sallseqid
sgi
sallgi
sacc
saccver
sallacc
slen
qstart
qend
sstart
send
qseq
sseq
evalue
bitscore
score
length
pident
nident
mismatch
positive
gapopen
gaps
ppos
frames
qframe
sframe
btop
staxid
ssciname
scomname
sblastname
sskingdom
staxids
sscinames
scomnames
sblastnames
sskingdoms
stitle
salltitles
sstrand
qcovs
qcovhsp
qcovus
SQ
SR
std

Inherits: lib.BlastOutField

showGIs Show GIs

boolean

Show NCBI GIs in deflines?

numDescriptions Number of Descriptions

integer

Number of database sequences to show one-line descriptions for.

Only applicable for the following formatType values:

pairwise
query-anchored-with-identities
query-anchored-no-identities
flat-query-anchored-with-identities
flat-query-anchored-no-identities

Incompatible with maxTargetSequences.

Format: int

numAlignments Number of Alignments

integer

Number of database sequences to show alignments for.

Incompatible with maxTargetSequences.

Format: int

lineLength Line Length

integer

Line length for formatting alignments

Only applicable for the following formatType values:

pairwise
query-anchored-with-identities
query-anchored-no-identities
flat-query-anchored-with-identities
flat-query-anchored-no-identities

Incompatible with maxTargetSequences.

Min. value: 1

Format: int

sortHits Sort Hits

string

Sorting option for hits.

Only applicable for the following formatType values:

pairwise
query-anchored-with-identities
query-anchored-no-identities
flat-query-anchored-with-identities
flat-query-anchored-no-identities

Enum:

by-evalue
by-bit-score
by-total-score
by-percent-identity
by-query-coverage

Inherits: lib.BlastHitSorting

sortHSPs Sort HSPs

string

Sorting option for HSPs.

Only applicable for formatType value pairwise.

Enum:

by-hsp-evalue
by-hsp-score
by-hsp-query-start
by-hsp-percent-identity
by-hsp-subject-start

Inherits: lib.BlastHSPSorting

maxTargetSequences Max Target Sequences

integer

Maximum number of aligned sequences to keep.

Incompatible with:

numDescriptions
numAlignments

Min. value: 5

parseDefLines Parse Query Definition Lines

boolean

Should the query and subject defline(s) be parsed?

Identifier	Description
pairwise	Pairwise
query-anchored-with-identities	Query-anchored showing identities
query-anchored-no-identities	Query-anchored no identities
flat-query-anchored-with-identities	Flat query-anchored showing identities
flat-query-anchored-no-identities	Flat query-anchored no identities
xml	BLAST XML
tabular	Tabular
tabular-with-comments	Tabular with comment lines
seqalign-text	Seqalign (Text ASN.1)
seqalign-binary	Seqalign (Binary ASN.1)
csv	Comma-separated values
asn1	BLAST archive (ASN.1)
seqalign-json	Seqalign (JSON)
multi-file-blast-json	Multiple-file BLAST JSON
multi-file-blast-xml2	Multiple-file BLAST XML2
single-file-blast-json	Single-file BLAST JSON
single-file-blast-xml2	Single-file BLAST XML2
sam	Sequence Alignment/Map (SAM)
organism-report	Organism Report

Enum:

pairwise
query-anchored-with-identities
query-anchored-no-identities
flat-query-anchored-with-identities
flat-query-anchored-no-identities
xml
tabular
tabular-with-comments
seqalign-text
seqalign-binary
csv
asn1
seqalign-json
multi-file-blast-json
multi-file-blast-xml2
single-file-blast-json
single-file-blast-xml2
sam
organism-report

Inherits: string

Field	Meaning
qseqid	Query Seq-id
qgi	Query GI
qacc	Query accesion
qaccver	Query accesion.version
qlen	Query sequence length
sseqid	Subject Seq-id
sallseqid	All subject Seq-id(s), separated by a ';'
sgi	Subject GI
sallgi	All subject GIs
sacc	Subject accession
saccver	Subject accession.version
sallacc	All subject accessions
slen	Subject sequence length
qstart	Start of alignment in query
qend	End of alignment in query
sstart	Start of alignment in subject
send	End of alignment in subject
qseq	Aligned part of query sequence
sseq	Aligned part of subject sequence
evalue	Expect value
bitscore	Bit score
score	Raw score
length	Alignment length
pident	Percentage of identical matches
nident	Number of identical matches
mismatch	Number of mismatches
positive	Number of positive-scoring matches
gapopen	Number of gap openings
gaps	Total number of gaps
ppos	Percentage of positive-scoring matches
frames	Query and subject frames separated by a '/'
qframe	Query frame
sframe	Subject frame
btop	Blast traceback operations (BTOP)
staxid	Subject Taxonomy ID
ssciname	Subject Scientific Name
scomname	Subject Common Name
sblastname	Subject Blast Name
sskingdom	Subject Super Kingdom
staxids	unique Subject Taxonomy ID(s), separated by a ';' (in numerical order)
sscinames	unique Subject Scientific Name(s), separated by a ';'
scomnames	unique Subject Common Name(s), separated by a ';'
sblastnames	unique Subject Blast Name(s), separated by a ';' (in alphabetical order)
sskingdoms	unique Subject Super Kingdom(s), separated by a ';' (in alphabetical order)
stitle	Subject Title
salltitles	All Subject Title(s), separated by a '<>'
sstrand	Subject Strand
qcovs	Query Coverage Per Subject
qcovhsp	Query Coverage Per HSP
qcovus	Query Coverage Per Unique Subject (blastn only)
SQ	Include Sequence Data
SR	Subject as Reference Seq
std	'qaccver saccver pident length mismatch gapopen qstart qend sstart send evalue bitscore'

Enum:

qseqid
qgi
qacc
qaccver
qlen
sseqid
sallseqid
sgi
sallgi
sacc
saccver
sallacc
slen
qstart
qend
sstart
send
qseq
sseq
evalue
bitscore
score
length
pident
nident
mismatch
positive
gapopen
gaps
ppos
frames
qframe
sframe
btop
staxid
ssciname
scomname
sblastname
sskingdom
staxids
sscinames
scomnames
sblastnames
sskingdoms
stitle
salltitles
sstrand
qcovs
qcovhsp
qcovus
SQ
SR
std

Inherits: string

Sorting option for hits.

Enum:

by-evalue
by-bit-score
by-total-score
by-percent-identity
by-query-coverage

Inherits: string

Sorting option for High Scoring Pairs

Enum:

by-hsp-evalue
by-hsp-score
by-hsp-query-start
by-hsp-percent-identity
by-hsp-subject-start

Inherits: string

Discriminator: status

Inherits: object

Model

Parameter	Type	Description
status*	string	Enum: bad-request unauthorized forbidden not-found bad-method invalid-input server-error Inherits: error.ErrorType
message*	string

Enum:

bad-request
unauthorized
forbidden
not-found
bad-method
invalid-input
server-error

Inherits: string

Request could not be parsed or was otherwise unusable.

Discriminator: status

Discriminator value: bad-request

Inherits: error.Error

Model

Parameter	Type	Description
status*	string	Enum: bad-request unauthorized forbidden not-found bad-method invalid-input server-error Inherits: error.ErrorType
message*	string

Examples

{
  "status": "bad-request",
  "message": "malformed JSON"
}

Unauthenticated client requested a resource that requires authentication.

Discriminator: status

Discriminator value: unauthorized

Inherits: error.Error

Model

Parameter	Type	Description
status*	string	Enum: bad-request unauthorized forbidden not-found bad-method invalid-input server-error Inherits: error.ErrorType
message*	string

Examples

{
  "status": "unauthorized",
  "message": "users must be logged in to access this resource"
}

Server understood the request but is refusing it.

Could be caused by incorrect instructions or an authenticated client requesting a resource or action that requires permissions that the client does not have assigned.

Discriminator: status

Discriminator value: forbidden

Inherits: error.Error

Model

Parameter	Type	Description
status*	string	Enum: bad-request unauthorized forbidden not-found bad-method invalid-input server-error Inherits: error.ErrorType
message*	string

Examples

{
  "status": "forbidden",
  "message": "the current user is not permitted to perform this action"
}

The requested resource was not found on this server.

Discriminator: status

Discriminator value: not-found

Inherits: error.Error

Model

Parameter	Type	Description
status*	string	Enum: bad-request unauthorized forbidden not-found bad-method invalid-input server-error Inherits: error.ErrorType
message*	string

Examples

{
  "status": "not-found",
  "message": "the requested resource could not be found"
}

The HTTP method used to request a resource is not allowed or configured by the server.

Discriminator: status

Discriminator value: bad-method

Inherits: error.Error

Model

Parameter	Type	Description
status*	string	Enum: bad-request unauthorized forbidden not-found bad-method invalid-input server-error Inherits: error.ErrorType
message*	string

Examples

{
  "status": "bad-method",
  "message": "PUT requests are not permitted on this endpoint"
}

The request payload or parameters are correctly structured but fail resource specific validation.

Discriminator: status

Discriminator value: invalid-input

Inherits: error.Error

Model

Parameter	Type	Description
status*	string	Enum: bad-request unauthorized forbidden not-found bad-method invalid-input server-error Inherits: error.ErrorType
message*	string
errors*	object	Additional properties: Yes
errors.general*	array	Non-field specific errors.
errors.general[]	string
errors.byKey*	object	Field specific errors Additional properties: Yes
errors.byKey.//*	array
errors.byKey.//[]	string

Examples

{
  "status": "invalid-input",
  "message": "JSON validation failed",
  "errors": {
    "general": [],
    "byKey": {
      "id": [
        "Given ID value does not point to an existing record."
      ]
    }
  }
}

Discriminator: status

Discriminator value: server-error

Inherits: error.Error

Model

Parameter	Type	Description
status*	string	Enum: bad-request unauthorized forbidden not-found bad-method invalid-input server-error Inherits: error.ErrorType
message*	string
requestId*	string

Examples

{
  "status": "server-error",
  "message": "Datastore connection lost",
  "requestId": "b296c3d9-4032-41b1-906e-c97ccfc447e3"
}

Health details about the service

Inherits: object

Model

Parameter	Type	Description
status*	string	Status describes the overall service state. A status of "healthy" indicates that everything is running smoothly and all service dependencies are reachable and online. A status of "unhealthy" indicates that something is wrong with either this service or one or more of it's dependency services. Enum: healthy unhealthy
dependencies*	array	A list of external services that this service depends on and some details about them.
dependencies[]	object	Inherits: DependencyStatus
dependencies[].name*	string	Name of the external depdendency.
dependencies[].reachable*	boolean	Whether or not the external service is reachable.
dependencies[].online*	string	Whether or not the external service is online and available for requests. Enum: yes unknown no
info*	object	Additional properties: Yes
info.threads*	integer	Min. value: 1
info.uptime*	string
info.uptimeMillis*	integer	Min. value: 1 Format: int64

Inherits: object

Model

Parameter	Type	Description
name*	string	Name of the external depdendency.
reachable*	boolean	Whether or not the external service is reachable.
online*	string	Whether or not the external service is online and available for requests. Enum: yes unknown no

MultiBlast Report Service v2.0.0

Parameters chevron_right expand_more

200 OK chevron_right expand_more

401 Unauthorized chevron_right expand_more

Response Body

500 Internal Server Error chevron_right expand_more

Response Body

Request Body chevron_right expand_more

200 OK chevron_right expand_more

400 Bad Request chevron_right expand_more

Response Body

401 Unauthorized chevron_right expand_more

Response Body

422 Unprocessable Entity chevron_right expand_more

Response Body

500 Internal Server Error chevron_right expand_more

Response Body

Parameters chevron_right expand_more

204 No Content chevron_right expand_more

401 Unauthorized chevron_right expand_more

Response Body

404 Not Found chevron_right expand_more

Response Body

500 Internal Server Error chevron_right expand_more

Response Body

Parameters chevron_right expand_more

200 OK chevron_right expand_more

401 Unauthorized chevron_right expand_more

Response Body

404 Not Found chevron_right expand_more

Response Body

500 Internal Server Error chevron_right expand_more

Response Body

Parameters chevron_right expand_more

204 No Content chevron_right expand_more

401 Unauthorized chevron_right expand_more

Response Body

403 Forbidden chevron_right expand_more

Response Body

404 Not Found chevron_right expand_more

Response Body

500 Internal Server Error chevron_right expand_more

Response Body

Parameters chevron_right expand_more

Request Body chevron_right expand_more

204 No Content chevron_right expand_more

400 Bad Request chevron_right expand_more

Response Body

401 Unauthorized chevron_right expand_more

Response Body

404 Not Found chevron_right expand_more

Response Body

422 Unprocessable Entity chevron_right expand_more

Response Body

500 Internal Server Error chevron_right expand_more

Response Body

Parameters chevron_right expand_more

200 OK chevron_right expand_more

Response Body

401 Unauthorized chevron_right expand_more

Response Body

403 Forbidden chevron_right expand_more

Response Body

404 Not Found chevron_right expand_more

Response Body

500 Internal Server Error chevron_right expand_more

Response Body

Parameters chevron_right expand_more

200 OK chevron_right expand_more

Headers

401 Unauthorized chevron_right expand_more

Response Body

403 Forbidden chevron_right expand_more

Response Body

404 Not Found chevron_right expand_more

Response Body

500 Internal Server Error chevron_right expand_more

Response Body

Parameters chevron_right expand_more

200 OK chevron_right expand_more

Parameters

200 OK

401 Unauthorized

500 Internal Server Error

Request Body

200 OK

400 Bad Request

401 Unauthorized

422 Unprocessable Entity

500 Internal Server Error

Parameters

204 No Content

401 Unauthorized

404 Not Found

500 Internal Server Error

Parameters

200 OK

401 Unauthorized

404 Not Found

500 Internal Server Error

Parameters

204 No Content

401 Unauthorized

403 Forbidden

404 Not Found

500 Internal Server Error

Parameters

Request Body

204 No Content

400 Bad Request

401 Unauthorized

404 Not Found

422 Unprocessable Entity

500 Internal Server Error

Parameters

200 OK

401 Unauthorized

403 Forbidden

404 Not Found

500 Internal Server Error

Parameters

200 OK

401 Unauthorized

403 Forbidden

404 Not Found

500 Internal Server Error

Parameters

200 OK

401 Unauthorized

403 Forbidden

404 Not Found

500 Internal Server Error

Request Body

200 OK