Structured Assertion Data
Data Type: structured_assertion
Primary Key: id
Attributes
-
_version_
(number)
-
comment
(string)
- Free-text explanation or qualifier for the assertion (e.g. “weak evidence”, “confers low-level resistance only”). Displayed in the evidence pop-up. "ISM family only confers partial resistance"
-
date_inserted
(date)
- ISO-8601 UTC datetime when this assertion row was created in BV-BRC. "2023-06-21T14:07:55Z"
-
date_modified
(date)
- Updated whenever any attribute changes; clients compare this value to refresh local caches. "2025-04-18T09:12:03Z"
-
evidence_code
(string)
- Controlled term (e.g. ECO:0000313 for “sequence similarity evidence”); lets users filter assertions by evidence strength. "ECO:0000044"
-
feature_id
(string)
- Stable `fig …` identifier of the gene/protein to which the assertion applies.
-
id
*
(string)
- Unique BV-BRC identifier for the assertion row (often feature_id│property│value). "511145.183.peg.1234│property:antibiotic_resistance│value:CIP"
-
owner
(string)
- BV-BRC user/org that controls write access. "patric_public"
-
patric_id
(string)
- Historical duplicate kept for older APIs; identical value to feature_id for CDS. `"fig
-
pmid
(string)
- Literature citation supporting the assertion. Blank if no paper. "22504819"
-
property
(string)
- What is being asserted – most commonly antibiotic_resistance, virulence_factor, essential_gene, etc. "antibiotic_resistance"
-
public
(boolean)
- true → assertion visible to all users; false → restricted to workspace owners. True
-
refseq_locus_tag
(string)
- Official NCBI tag for the feature; useful for cross-references. "ECOLI_RS05420"
-
score
(string)
- Numeric or qualitative confidence measure (“0.92”, “high”). Stored as string to preserve formatting. "0.92"
-
source
(string)
- PATRIC, CARD, literature_curation, user_upload, etc. "CARD"
-
user_read
(array of strings)
- BV-BRC user/org IDs permitted to view the record ("public" if open). [ "public" ]
-
user_write
(array of strings)
- IDs allowed to modify/delete the assertion. [ "[email protected]" ]
-
value
(string)
- Specific statement that pairs with property (e.g. antibiotic name, virulence category). "ciprofloxacin"
API
GET :id
Retrieve a structured_assertion data object by id
EXAMPLE
https://www.bv-brc.org/api/structured_assertion/001382b1-55e4-4581-ba85-c2744a2dbeb8
Try It!
QUERY :query
Query for structured_assertion data objects with an RQL Query
Return Formats
Requests may include an HTTP ACCEPT header from this list to transform the data into the requested type.
-
application/json - Returns results as an array of JSON objects
-
application/solr+json - Results results in SOLR JSON response format
-
text/csv - Returns results in Comma Separated values (CSV) format. Columns are separated by ','. Multi-value columns are separated by ';'. Rows are separated by new line
-
text/tsv - Returns results in Tab Separated values (TSV) format. Columns are separated by a tab. Multi-value columns are separated by ';'. Rows are separated by new line
-
application/vnd.openxmlformats - Returns objects as an MS Excel document
EXAMPLE
- Query for structured_assertion data objects with a id equal to 001382b1-55e4-4581-ba85-c2744a2dbeb8. Return results as a JSON Array.
https://www.bv-brc.org/api/structured_assertion/?eq(id,001382b1-55e4-4581-ba85-c2744a2dbeb8)
Try It!