From ed975ea2146455b7806553860876bc3501a89746 Mon Sep 17 00:00:00 2001 From: Brianna Dirks <148362578+bridirks@users.noreply.github.com> Date: Tue, 9 Dec 2025 17:07:11 -0500 Subject: [PATCH 1/5] Update chemical.json --- public/docs/chemical.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/public/docs/chemical.json b/public/docs/chemical.json index 56effe5..41c46c7 100644 --- a/public/docs/chemical.json +++ b/public/docs/chemical.json @@ -8,7 +8,7 @@ "servers": [ { "url": "https://ctx-api-dev.ccte.epa.gov", - "description": "Staging Environment" + "description": "Development Environment" } ], "tags": [ From 5f2503e1deb3000f425cc51bbaef3fab50248eee Mon Sep 17 00:00:00 2001 From: bedirks Date: Thu, 11 Dec 2025 16:27:35 -0500 Subject: [PATCH 2/5] Hide additional chemical endpoints from public view (DEV) #19 --- public/docs/chemical.json | 232 -------------------------------------- 1 file changed, 232 deletions(-) diff --git a/public/docs/chemical.json b/public/docs/chemical.json index 41c46c7..231895c 100644 --- a/public/docs/chemical.json +++ b/public/docs/chemical.json @@ -39,62 +39,9 @@ { "name": "Lit Search Data Resource", "description": "Collection of endpoints containing extra chemical data pertaining to literature and patents." - }, - { - "name": "PubChem to GHS Classification Resource", - "description": "Collection of endpoints to check if GHS classification safety data in available in PubChem." - }, - { - "name": "Wikipedia to GHS Classification Resource", - "description": "Collection of endpoints to check if GHS classification safety data is available on Wikipedia." } ], "paths": { - "/chemical/wikipedia/by-dtxsid/": { - "post": { - "tags": [ - "Wikipedia to GHS Classification Resource" - ], - "summary": "Check for link for a batch of DTXSIDs", - "description": "This endpoint will return Y if Wikipedia has GHS Safety data, otherwise N.", - "operationId": "byBatchDtxsid", - "requestBody": { - "description": "JSON array of DSSTox Substance Identifiers", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "type": "string" - } - }, - "example": "[\"DTXSID7020182\",\"DTXSID9020112\"]" - } - }, - "required": true - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/WikipediaLinkResponse" - } - } - } - } - } - }, - "security": [ - { - "api_key": [] - } - ] - } - }, "/chemical/synonym/search/by-dtxsid/": { "post": { "tags": [ @@ -441,51 +388,6 @@ ] } }, - "/chemical/ghslink/to-dtxsid/": { - "post": { - "tags": [ - "PubChem to GHS Classification Resource" - ], - "summary": "Check for link for a batch of DTXSIDs", - "description": "This endpoint will return Y if Pubchem has GHS Safety data, otherwise N.", - "operationId": "byBatchDtxsid_1", - "requestBody": { - "description": "JSON array of DSSTox Substance Identifiers", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "type": "string" - } - }, - "example": "[\"DTXSID7020182\",\"DTXSID9020112\"]" - } - }, - "required": true - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GhsLinkResponse" - } - } - } - } - } - }, - "security": [ - { - "api_key": [] - } - ] - } - }, "/chemical/fate/search/by-dtxsid/": { "post": { "tags": [ @@ -768,45 +670,6 @@ ] } }, - "/chemical/wikipedia/by-dtxsid/{dtxsid}": { - "get": { - "tags": [ - "Wikipedia to GHS Classification Resource" - ], - "summary": "Check for link by DTXSID", - "description": "This endpoint will return Y if Wikipedia has GHS Safety data, otherwise N.", - "operationId": "byDtxsid", - "parameters": [ - { - "name": "dtxsid", - "in": "path", - "description": "DSSTox Substance Identifier", - "required": true, - "schema": { - "type": "string" - }, - "example": "DTXSID7020182" - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/WikipediaLinkResponse" - } - } - } - } - }, - "security": [ - { - "api_key": [] - } - ] - } - }, "/chemical/synonym/search/by-dtxsid/{dtxsid}": { "get": { "tags": [ @@ -2218,45 +2081,6 @@ ] } }, - "/chemical/ghslink/to-dtxsid/{dtxsid}": { - "get": { - "tags": [ - "PubChem to GHS Classification Resource" - ], - "summary": "Check for link by DTXSID", - "description": "This endpoint will return Y if Pubchem has GHS Safety data, otherwise N.", - "operationId": "byDtxsid_1", - "parameters": [ - { - "name": "dtxsid", - "in": "path", - "description": "DSSTox Substance Identifier", - "required": true, - "schema": { - "type": "string" - }, - "example": "DTXSID7020182" - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GhsLinkResponse" - } - } - } - } - }, - "security": [ - { - "api_key": [] - } - ] - } - }, "/chemical/file/mol/search/by-dtxsid/{dtxsid}": { "get": { "tags": [ @@ -3000,62 +2824,6 @@ } ] } - }, - "/chemical/all": { - "get": { - "tags": [ - "Chemical Details Resource" - ], - "summary": "Get all data", - "description": "return all chemical details. The next parameter allows pagination for retrieval, but retrieval is limited to batches of 1000 per request. Please consider downloading the DSSTOX database instead accessing this information via API.", - "operationId": "getAllChemicalDetails", - "parameters": [ - { - "name": "next", - "in": "query", - "required": false, - "schema": { - "type": "integer", - "format": "int64", - "default": 1 - } - }, - { - "name": "projection", - "in": "query", - "description": "Specifies if projection is used. Option: all-ids. If omitted, the default ChemicalDetailStandard2 data is returned.", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "string", - "oneOf": [ - { - "$ref": "#/components/schemas/ChemicalDetailStandard2" - }, - { - "$ref": "#/components/schemas/ChemicalDetailAllIds" - } - ] - } - } - } - } - }, - "security": [ - { - "api_key": [] - } - ] - } } }, "components": { From ff4c781bd8a317deff9d4bb340ff252a41a4afbc Mon Sep 17 00:00:00 2001 From: Brianna Dirks <148362578+bridirks@users.noreply.github.com> Date: Thu, 11 Dec 2025 16:40:52 -0500 Subject: [PATCH 3/5] Update chemical.json --- public/docs/chemical.json | 40 --------------------------------------- 1 file changed, 40 deletions(-) diff --git a/public/docs/chemical.json b/public/docs/chemical.json index 231895c..9d5b9e7 100644 --- a/public/docs/chemical.json +++ b/public/docs/chemical.json @@ -2828,17 +2828,6 @@ }, "components": { "schemas": { - "WikipediaLinkResponse": { - "type": "object", - "properties": { - "dtxsid": { - "type": "string" - }, - "safetyUrl": { - "type": "string" - } - } - }, "ChemicalSynonymAll": { "type": "object", "description": "Different types of synonyms for request dtxsid", @@ -3293,20 +3282,6 @@ "masses" ] }, - "GhsLinkResponse": { - "type": "object", - "properties": { - "dtxsid": { - "type": "string" - }, - "isSafetyData": { - "type": "boolean" - }, - "safetyUrl": { - "type": "string" - } - } - }, "ChemicalFateBatchDto": { "type": "object", "properties": { @@ -4274,21 +4249,6 @@ } } }, - "ChemicalDetailAllIds": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "dtxcid": { - "type": "string" - }, - "dtxsid": { - "type": "string" - } - } - }, "Link": { "type": "object", "properties": { From f2acfae5f6ff3a1aa49761dca5603003d451c94c Mon Sep 17 00:00:00 2001 From: popenc <7785228+popenc@users.noreply.github.com> Date: Tue, 21 Apr 2026 13:09:13 -0400 Subject: [PATCH 4/5] Fix formatting in GitHub Actions workflow file --- .github/workflows/docker-build-push-ghcr.yml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/.github/workflows/docker-build-push-ghcr.yml b/.github/workflows/docker-build-push-ghcr.yml index 43a2486..7eda66a 100644 --- a/.github/workflows/docker-build-push-ghcr.yml +++ b/.github/workflows/docker-build-push-ghcr.yml @@ -7,9 +7,10 @@ name: Docker-ghcr on: push: - branches: [ "dev", "staging", "main", local-dev ] + branches: [ "dev", "staging", "main", "local-dev" ] # Publish semver tags as releases. tags: [ 'v*.*.*' ] + workflow_dispatch: env: # Use docker.io for Docker Hub if empty From c9c1b48b9b8473d07d58e1ac537d4277f6ee6655 Mon Sep 17 00:00:00 2001 From: jkuntzel Date: Mon, 24 Aug 2026 08:14:14 -0500 Subject: [PATCH 5/5] CE-5324 - updated the CTX API JSON files for the documentation service --- public/docs/bioactivity.json | 6183 ++++++++++++------------ public/docs/chemical.json | 8660 ++++++++++++++++++---------------- public/docs/exposure.json | 60 +- public/docs/hazard.json | 6799 +++++++++++++------------- 4 files changed, 10993 insertions(+), 10709 deletions(-) diff --git a/public/docs/bioactivity.json b/public/docs/bioactivity.json index 8c5b635..18be93c 100644 --- a/public/docs/bioactivity.json +++ b/public/docs/bioactivity.json @@ -1,3205 +1,3216 @@ { - "openapi": "3.1.0", - "info": { - "title": "Computational Toxicology and Exposure (CTX) APIs - CTX Bioactivity API", - "description": "The CTX Bioactivity API is part of US EPA's Computational Toxicology and Exposure APIs. The CTX Bioactivity API provides programmtic access to bioactivity data through a set of endpoints.", - "version": "1.1.1" + "openapi": "3.1.0", + "info": { + "title": "Computational Toxicology and Exposure (CTX) APIs - CTX Bioactivity API", + "description": "The CTX Bioactivity API is part of US EPA's Computational Toxicology and Exposure APIs. The CTX Bioactivity API provides programmtic access to bioactivity data through a set of endpoints.", + "version": "1.1.1" + }, + "servers": [ + { + "url": "https://comptox.epa.gov/ctx-api", + "description": "Production Environment" + } + ], + "tags": [ + { + "name": "Analytical QC Resource", + "description": "Endpoint for Analytical QC data to inform the chemical's applicability domain for in vitro screening at the sample and substance level. These curated data sourced from US EPA's Toxicity Forecaster (ToxCast) invitrodb." }, - "servers": [ - { - "url": "https://ctx-api-dev.ccte.epa.gov", - "description": "Development Environment" - } - ], - "tags": [ - { - "name": "Bioactivity Assay Resource", - "description": "Collection of endpoints for assay annotations. Annotations describe who conducted the assay, what platform was used, what was being measured (raw readout), and how the measurement was interpreted (normalized component data). Assay annotations facilitate data interpretation by allowing users to flexibly aggregate and differentiate processed data. These curated data sourced from US EPA's Toxicity Forecaster (ToxCast) invitrodb." - }, - { - "name": "Bioactivity Data Resource", - "description": "Collection of endpoints with multiple-concentration targeted bioactivity screening data. These curated data sourced from US EPA's Toxicity Forecaster (ToxCast) invitrodb." - }, - { - "name": "Bioactivity Model Resource", - "description": "Collection of endpoints for prediction results from ToxCast bioactivity models. The publications associated with the ToxCast Pathway Models are: 1) ESTROGEN: As described in Browne, et al (2015) DOI: 10.1021/acs.est.5b02641 and presented to December 2014 FIFRA SAP under EPA-HQ-OPP-2014-0614. 2) ANDROGEN: As described in Kleinstreuer et al (2017) 10.1021/acs.chemrestox.6b00347 and presented to November 2017 FIFRA SAP under EPA-HQ-OPP-2017-0214." - }, - { - "name": "Analytical QC Resource", - "description": "Endpoint for Analytical QC data to inform the chemical's applicability domain for in vitro screening at the sample and substance level. These curated data sourced from US EPA's Toxicity Forecaster (ToxCast) invitrodb." - }, - { - "name": "Assay Name Search Resource", - "description": "Collection of endpoints for searching by assay name. Search string options include starts-with, exact, or contains." + { + "name": "Bioactivity Model Resource", + "description": "Collection of endpoints for prediction results from ToxCast bioactivity models. The publications associated with the ToxCast Pathway Models are: 1) ESTROGEN: As described in Browne, et al (2015) DOI: 10.1021/acs.est.5b02641 and presented to December 2014 FIFRA SAP under EPA-HQ-OPP-2014-0614. 2) ANDROGEN: As described in Kleinstreuer et al (2017) 10.1021/acs.chemrestox.6b00347 and presented to November 2017 FIFRA SAP under EPA-HQ-OPP-2017-0214." + }, + { + "name": "Bioactivity Assay Resource", + "description": "Collection of endpoints for assay annotations. Annotations describe who conducted the assay, what platform was used, what was being measured (raw readout), and how the measurement was interpreted (normalized component data). Assay annotations facilitate data interpretation by allowing users to flexibly aggregate and differentiate processed data. These curated data sourced from US EPA's Toxicity Forecaster (ToxCast) invitrodb." + }, + { + "name": "CCD AOP Data Resource", + "description": "Collection of endpoints used to populate CompTox Chemicals Dashboard (CCD) Adverse Outcome Pathway (AOP) and Key Event (KE) links within the ToxCast Summary Grid. Curated mappings of AOPs and KEs for individual ToxCast assay endpoints are made available in ToxCast's invitrodb." + }, + { + "name": "Bioactivity Data Resource", + "description": "Collection of endpoints with multiple-concentration targeted bioactivity screening data. These curated data sourced from US EPA's Toxicity Forecaster (ToxCast) invitrodb." + }, + { + "name": "Assay Name Search Resource", + "description": "Collection of endpoints for searching by assay name. Search string options include starts-with, exact, or contains." + } + ], + "paths": { + "/bioactivity/data/search/by-spid/": { + "post": { + "tags": [ + "Bioactivity Data Resource" + ], + "summary": "Get data for a batch of SPIDs", + "description": "return data for requested sample IDs (SPIDs)", + "operationId": "batchSearchDataBySpid", + "requestBody": { + "description": "JSON array of SPIDs", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "example": "[\"EPAPLT0232A03\",\"TP0000311A04\"]" + } + }, + "required": true }, - { - "name": "CCD AOP Data Resource", - "description": "Collection of endpoints used to populate CompTox Chemicals Dashboard (CCD) Adverse Outcome Pathway (AOP) and Key Event (KE) links within the ToxCast Summary Grid. Curated mappings of AOPs and KEs for individual ToxCast assay endpoints are made available in ToxCast's invitrodb." - } - ], - "paths": { - "/bioactivity/data/search/by-spid/": { - "post": { - "tags": [ - "Bioactivity Data Resource" - ], - "summary": "Get data for a batch of SPIDs", - "description": "return data for requested sample IDs (SPIDs)", - "operationId": "batchSearchDataBySpid", - "requestBody": { - "description": "JSON array of SPIDs", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "type": "string" - } - }, - "example": "[\"EPAPLT0232A03\",\"TP0000311A04\"]" - } - }, - "required": true - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "string", - "oneOf": [ - { - "$ref": "#/components/schemas/BioactivityDataAll" - } - ] - } - } - } - } - }, - "security": [ + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "string", + "oneOf": [ { - "api_key": [] + "$ref": "#/components/schemas/BioactivityDataAll" } - ] + ] + } + } } + } }, - "/bioactivity/data/search/by-m4id/": { - "post": { - "tags": [ - "Bioactivity Data Resource" - ], - "summary": "Get data for a batch of M4IDs", - "description": "return data for requested Level 4 IDs (M4IDs), corresponding to the individual modeled endpoint-sample concentration-responses", - "operationId": "batchSearchDataByM4id", - "requestBody": { - "description": "JSON array of M4IDs", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "type": "string" - } - }, - "example": "[\"7826737\",\"7834113\"]" - } - }, - "required": true - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "string", - "oneOf": [ - { - "$ref": "#/components/schemas/BioactivityDataAll" - } - ] - } - } - } - } - }, - "security": [ - { - "api_key": [] - } - ] + "security": [ + { + "api_key": [] + } + ] + } + }, + "/bioactivity/data/search/by-m4id/": { + "post": { + "tags": [ + "Bioactivity Data Resource" + ], + "summary": "Get data for a batch of M4IDs", + "description": "return data for requested Level 4 IDs (M4IDs), corresponding to the individual modeled endpoint-sample concentration-responses", + "operationId": "batchSearchDataByM4id", + "requestBody": { + "description": "JSON array of M4IDs", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "example": "[\"7826737\",\"7834113\"]" } + }, + "required": true }, - "/bioactivity/data/search/by-dtxsid/": { - "post": { - "tags": [ - "Bioactivity Data Resource" - ], - "summary": "Get bioactivity data for a batch of DTXSIDs", - "description": "return data for requested DTXSIDs.", - "operationId": "batchSearchDataByDtxsid", - "requestBody": { - "description": "JSON array of DSSTox Substance Identifiers", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "type": "string" - } - }, - "example": "[\"DTXSID9026974\",\"DTXSID9020112\"]" - } - }, - "required": true - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "string", - "oneOf": [ - { - "$ref": "#/components/schemas/BioactivityDataAll" - } - ] - } - } - } - } - }, - "security": [ + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "string", + "oneOf": [ { - "api_key": [] + "$ref": "#/components/schemas/BioactivityDataAll" } - ] + ] + } + } } + } }, - "/bioactivity/data/search/by-aeid/": { - "post": { - "tags": [ - "Bioactivity Data Resource" - ], - "summary": "Get data for a batch of AEIDs", - "description": "return data for requested ToxCast assay component endpoint IDs (AEIDs)", - "operationId": "batchSearchDataByAeid", - "requestBody": { - "description": "JSON array of ToxCast assay component endpoint IDs (AEIDs)", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "type": "string" - } - }, - "example": "[\"3032\",\"755\"]" - } - }, - "required": true - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "string", - "oneOf": [ - { - "$ref": "#/components/schemas/BioactivityDataAll" - } - ] - } - } - } - } - }, - "security": [ - { - "api_key": [] - } - ] + "security": [ + { + "api_key": [] + } + ] + } + }, + "/bioactivity/data/search/by-dtxsid/": { + "post": { + "tags": [ + "Bioactivity Data Resource" + ], + "summary": "Get bioactivity data for a batch of DTXSIDs", + "description": "return data for requested DTXSIDs.", + "operationId": "batchSearchDataByDtxsid", + "requestBody": { + "description": "JSON array of DSSTox Substance Identifiers", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "example": "[\"DTXSID9026974\",\"DTXSID9020112\"]" } + }, + "required": true }, - "/bioactivity/data/aed/search/by-dtxsid/": { - "post": { - "tags": [ - "Bioactivity Data Resource" - ], - "summary": "Get AED data for a batch of DTXSIDs", - "description": "return administered equivalent dose (AED) data derived from ToxCast in vitro bioactivity data for given DTXSIDs", - "operationId": "getAedDataForBatchDtxsids", - "requestBody": { - "description": "JSON array of DSSTox Substance Identifiers", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "type": "string" - } - }, - "example": "[\"DTXSID7020182\",\"DTXSID9020112\"]" - } - }, - "required": true - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AedData" - } - } - } - } - } - }, - "security": [ + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "string", + "oneOf": [ { - "api_key": [] + "$ref": "#/components/schemas/BioactivityDataAll" } - ] + ] + } + } } + } }, - "/bioactivity/assay/search/by-aeid/": { - "post": { - "tags": [ - "Bioactivity Assay Resource" - ], - "summary": "Get assay annotations for a batch of AEIDs", - "description": "return assay annotations for requested ToxCast assay component endpoint IDs (AEIDs)", - "operationId": "batchSearchAssayByAeid", - "requestBody": { - "description": "JSON array of DSSTox Substance Identifiers", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "type": "string" - } - }, - "example": "[\"111\",\"3032\"]" - } - }, - "required": true - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "string", - "oneOf": [ - { - "$ref": "#/components/schemas/AssayAll" - } - ] - } - } - } - } - }, - "security": [ - { - "api_key": [] - } - ] + "security": [ + { + "api_key": [] + } + ] + } + }, + "/bioactivity/data/search/by-aeid/": { + "post": { + "tags": [ + "Bioactivity Data Resource" + ], + "summary": "Get data for a batch of AEIDs", + "description": "return data for requested ToxCast assay component endpoint IDs (AEIDs)", + "operationId": "batchSearchDataByAeid", + "requestBody": { + "description": "JSON array of ToxCast assay component endpoint IDs (AEIDs)", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "example": "[\"3032\",\"755\"]" } + }, + "required": true }, - "/bioactivity/search/start-with/{value}": { - "get": { - "tags": [ - "Assay Name Search Resource" - ], - "summary": "Search by starting value", - "description": "NOTE: Search value needs to be URL encoded for synonyms", - "operationId": "assayStartWith", - "parameters": [ - { - "name": "value", - "in": "path", - "description": "Starting characters for search value", - "required": true, - "schema": { - "type": "string" - }, - "examples": { - "Search Value": { - "description": "Search Value", - "value": "ATG_S" - } - } - }, - { - "name": "top", - "in": "query", - "required": false, - "schema": { - "type": "integer", - "format": "int32", - "default": 500 - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "string", - "oneOf": [ - { - "$ref": "#/components/schemas/SearchAssay" - } - ] - } - } - } - }, - "400": { - "description": "No data found", - "content": { - "application/problem+json": { - "schema": { - "type": "string", - "oneOf": [ - { - "$ref": "#/components/schemas/ProblemDetail" - } - ] - } - } - } - } - }, - "security": [ + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "string", + "oneOf": [ { - "api_key": [] + "$ref": "#/components/schemas/BioactivityDataAll" } - ] + ] + } + } } + } }, - "/bioactivity/search/equal/{value}": { - "get": { - "tags": [ - "Assay Name Search Resource" - ], - "summary": "Search by exact value", - "description": "NOTE: Search value needs to be URL encoded for synonyms", - "operationId": "assayEqual", - "parameters": [ - { - "name": "value", - "in": "path", - "description": "Exact match of search value", - "required": true, - "schema": { - "type": "string" - }, - "examples": { - "Search Value": { - "description": "Search Value", - "value": "ATG_STAT3_CIS" - } - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "string", - "oneOf": [ - { - "$ref": "#/components/schemas/SearchAssay" - } - ] - } - } - } - }, - "400": { - "description": "No data found", - "content": { - "application/problem+json": { - "schema": { - "type": "string", - "oneOf": [ - { - "$ref": "#/components/schemas/ProblemDetail" - } - ] - } - } - } - } - }, - "security": [ - { - "api_key": [] - } - ] + "security": [ + { + "api_key": [] + } + ] + } + }, + "/bioactivity/data/aed/search/by-dtxsid/": { + "post": { + "tags": [ + "Bioactivity Data Resource" + ], + "summary": "Get AED data for a batch of DTXSIDs", + "description": "return administered equivalent dose (AED) data derived from ToxCast in vitro bioactivity data for given DTXSIDs", + "operationId": "getAedDataForBatchDtxsids", + "requestBody": { + "description": "JSON array of DSSTox Substance Identifiers", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "example": "[\"DTXSID7020182\",\"DTXSID9020112\"]" } + }, + "required": true }, - "/bioactivity/search/contain/{value}": { - "get": { - "tags": [ - "Assay Name Search Resource" - ], - "summary": "Search by substring value", - "description": "NOTE: Search value needs to be URL encoded for synonyms", - "operationId": "assayContain", - "parameters": [ - { - "name": "value", - "in": "path", - "description": "Substring of search word", - "required": true, - "schema": { - "type": "string" - }, - "examples": { - "Search Value": { - "description": "Search Value", - "value": "AT3_CIS" - }, - "Synonym": { - "description": "Synonym", - "value": "razine" - } - } - }, - { - "name": "top", - "in": "query", - "required": false, - "schema": { - "type": "integer", - "format": "int32", - "default": 0 - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "string", - "oneOf": [ - { - "$ref": "#/components/schemas/SearchAssay" - } - ] - } - } - } - }, - "400": { - "description": "No data found", - "content": { - "application/problem+json": { - "schema": { - "type": "string", - "oneOf": [ - { - "$ref": "#/components/schemas/ProblemDetail" - } - ] - } - } - } - } - }, - "security": [ - { - "api_key": [] - } - ] + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AedData" + } + } + } } + } }, - "/bioactivity/models/search/by-dtxsid/{dtxsid}": { - "get": { - "tags": [ - "Bioactivity Model Resource" - ], - "summary": "Get predictions by DTXSID", - "description": "return ToxCast model predictions for a given DTXSID", - "operationId": "getBioactivityModelByDtxsid", - "parameters": [ - { - "name": "dtxsid", - "in": "path", - "description": "dtxsid", - "required": true, - "schema": { - "type": "string" - }, - "example": "DTXSID7020182" - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/BioactivityModel" - } - } - } - } - } - }, - "security": [ - { - "api_key": [] - } - ] + "security": [ + { + "api_key": [] + } + ] + } + }, + "/bioactivity/assay/search/by-aeid/": { + "post": { + "tags": [ + "Bioactivity Assay Resource" + ], + "summary": "Get assay annotations for a batch of AEIDs", + "description": "return assay annotations for requested ToxCast assay component endpoint IDs (AEIDs)", + "operationId": "batchSearchAssayByAeid", + "requestBody": { + "description": "JSON array of ToxCast assay component endpoint IDs (AEIDs)", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "example": "[\"111\",\"3032\"]" } + }, + "required": true }, - "/bioactivity/models/search/": { - "get": { - "tags": [ - "Bioactivity Model Resource" - ], - "summary": "Get predictions by DTXSID and model", - "description": "return ToxCast model predictions for given a DTXSID and model type. Model type options include: 'CERAPP Potency Level (Consensus)', 'CERAPP Potency Level (From Literature)', 'COMPARA (Consensus)', and 'ToxCast Pathway Model (AUC)'", - "operationId": "getBioactivityModelByDtxsidAndModel", - "parameters": [ + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "string", + "oneOf": [ { - "name": "dtxsid", - "in": "query", - "description": "dtxsid", - "required": true, - "schema": { - "type": "string" - }, - "example": "DTXSID7020182" - }, - { - "name": "model", - "in": "query", - "description": "model", - "required": true, - "schema": { - "type": "string" - }, - "example": "CERAPP " - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/BioactivityModel" - } - } - } - } - } - }, - "security": [ - { - "api_key": [] + "$ref": "#/components/schemas/AssayAll" } - ] + ] + } + } } + } }, - "/bioactivity/data/summary/search/by-tissue/": { - "get": { - "tags": [ - "Bioactivity Data Resource" - ], - "summary": "Get summary data by DTXSID and assay tissue origin", - "description": "return summary data for given DTXSID and the assay format's tissue origin", - "operationId": "summaryByDtxsidAndTissue", - "parameters": [ - { - "name": "dtxsid", - "in": "query", - "description": "DSSTox Substance Identifier", - "required": true, - "schema": { - "type": "string" - }, - "example": "DTXSID7024241" - }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/bioactivity/search/start-with/{value}": { + "get": { + "tags": [ + "Assay Name Search Resource" + ], + "summary": "Search by starting value", + "description": "NOTE: Search value needs to be URL encoded for synonyms", + "operationId": "assayStartWith", + "parameters": [ + { + "name": "value", + "in": "path", + "description": "Starting characters for search value", + "required": true, + "schema": { + "type": "string" + }, + "examples": { + "Search Value": { + "description": "Search Value", + "value": "ATG_S" + } + } + }, + { + "name": "top", + "in": "query", + "required": false, + "schema": { + "type": "integer", + "format": "int32", + "default": 500 + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "string", + "oneOf": [ { - "name": "tissue", - "in": "query", - "description": "assay format's tissue of origin", - "required": true, - "schema": { - "type": "string" - }, - "example": "liver" + "$ref": "#/components/schemas/SearchAssay" } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "string", - "oneOf": [ - { - "$ref": "#/components/schemas/SummaryByTissue" - } - ] - } - } - } - } - }, - "security": [ + ] + } + } + } + }, + "400": { + "description": "No data found", + "content": { + "application/problem+json": { + "schema": { + "type": "string", + "oneOf": [ { - "api_key": [] + "$ref": "#/components/schemas/ProblemDetail" } - ] + ] + } + } } + } }, - "/bioactivity/data/summary/search/by-dtxsid/{dtxsid}": { - "get": { - "tags": [ - "Bioactivity Data Resource" - ], - "summary": "Get summary data by DTXSID", - "description": "return summary of active hits and total multi- and single-concentration assays tested for given DTXSID", - "operationId": "summaryByDtxsid", - "parameters": [ + "security": [ + { + "api_key": [] + } + ] + } + }, + "/bioactivity/search/equal/{value}": { + "get": { + "tags": [ + "Assay Name Search Resource" + ], + "summary": "Search by exact value", + "description": "NOTE: Search value needs to be URL encoded for synonyms", + "operationId": "assayEqual", + "parameters": [ + { + "name": "value", + "in": "path", + "description": "Exact match of search value", + "required": true, + "schema": { + "type": "string" + }, + "examples": { + "Search Value": { + "description": "Search Value", + "value": "ATG_STAT3_CIS" + } + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "string", + "oneOf": [ { - "name": "dtxsid", - "in": "path", - "description": "DSSTox Substance Identifier", - "required": true, - "schema": { - "type": "string" - }, - "example": "DTXSID9026974" - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "string", - "oneOf": [ - { - "$ref": "#/components/schemas/ChemicalAgg" - } - ] - } - } - } + "$ref": "#/components/schemas/SearchAssay" } - }, - "security": [ + ] + } + } + } + }, + "400": { + "description": "No data found", + "content": { + "application/problem+json": { + "schema": { + "type": "string", + "oneOf": [ { - "api_key": [] + "$ref": "#/components/schemas/ProblemDetail" } - ] + ] + } + } } + } }, - "/bioactivity/data/summary/search/by-aeid/{aeid}": { - "get": { - "tags": [ - "Bioactivity Data Resource" - ], - "summary": "Get summary data by AEID", - "description": "return summary of active hits and total multi- and single-concentration chemicals tested for given ToxCast assay component endpoint ID (AEID)", - "operationId": "summaryByAeid", - "parameters": [ + "security": [ + { + "api_key": [] + } + ] + } + }, + "/bioactivity/search/contain/{value}": { + "get": { + "tags": [ + "Assay Name Search Resource" + ], + "summary": "Search by substring value", + "description": "NOTE: Search value needs to be URL encoded for synonyms", + "operationId": "assayContain", + "parameters": [ + { + "name": "value", + "in": "path", + "description": "Substring of search word", + "required": true, + "schema": { + "type": "string" + }, + "examples": { + "Search Value": { + "description": "Search Value", + "value": "AT3_CIS" + }, + "Synonym": { + "description": "Synonym", + "value": "razine" + } + } + }, + { + "name": "top", + "in": "query", + "required": false, + "schema": { + "type": "integer", + "format": "int32", + "default": 0 + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "string", + "oneOf": [ { - "name": "aeid", - "in": "path", - "description": "ToxCast assay component endpoint ID (AEID)", - "required": true, - "schema": { - "type": "integer", - "format": "int32" - }, - "example": 3032 - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "string", - "oneOf": [ - { - "$ref": "#/components/schemas/AssayAgg" - } - ] - } - } - } + "$ref": "#/components/schemas/SearchAssay" } - }, - "security": [ + ] + } + } + } + }, + "400": { + "description": "No data found", + "content": { + "application/problem+json": { + "schema": { + "type": "string", + "oneOf": [ { - "api_key": [] + "$ref": "#/components/schemas/ProblemDetail" } - ] + ] + } + } } + } }, - "/bioactivity/data/search/by-spid/{spid}": { - "get": { - "tags": [ - "Bioactivity Data Resource" - ], - "summary": "Get data by SPID", - "description": "return data for given sample ID (SPID)", - "operationId": "dataBySpid", - "parameters": [ - { - "name": "spid", - "in": "path", - "description": "sample ID (SPID)", - "required": true, - "schema": { - "type": "string" - }, - "example": "EPAPLT0232A03" - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/BioactivityDataAll" - } - } - } - } - } - }, - "security": [ - { - "api_key": [] - } - ] + "security": [ + { + "api_key": [] + } + ] + } + }, + "/bioactivity/models/search/by-dtxsid/{dtxsid}": { + "get": { + "tags": [ + "Bioactivity Model Resource" + ], + "summary": "Get predictions by DTXSID", + "description": "return ToxCast model predictions for a given DTXSID", + "operationId": "getBioactivityModelByDtxsid", + "parameters": [ + { + "name": "dtxsid", + "in": "path", + "description": "dtxsid", + "required": true, + "schema": { + "type": "string" + }, + "example": "DTXSID7020182" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/BioactivityModel" + } + } + } } + } }, - "/bioactivity/data/search/by-m4id/{m4id}": { - "get": { - "tags": [ - "Bioactivity Data Resource" - ], - "summary": "Get data by M4ID", - "description": "return data for given Level 4 ID (M4ID), corresponding to the individual modeled endpoint-sample concentration-response", - "operationId": "dataByM4Id", - "parameters": [ - { - "name": "m4id", - "in": "path", - "description": "M4ID", - "required": true, - "schema": { - "type": "integer", - "format": "int32" - }, - "example": 7826737 - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "string", - "oneOf": [ - { - "$ref": "#/components/schemas/BioactivityDataAll" - } - ] - } - } - } - } - }, - "security": [ - { - "api_key": [] - } - ] + "security": [ + { + "api_key": [] + } + ] + } + }, + "/bioactivity/models/search/": { + "get": { + "tags": [ + "Bioactivity Model Resource" + ], + "summary": "Get predictions by DTXSID and model", + "description": "return ToxCast model predictions for given a DTXSID and model type. Model type options include: 'CERAPP Potency Level (Consensus)', 'CERAPP Potency Level (From Literature)', 'COMPARA (Consensus)', and 'ToxCast Pathway Model (AUC)'", + "operationId": "getBioactivityModelByDtxsidAndModel", + "parameters": [ + { + "name": "dtxsid", + "in": "query", + "description": "dtxsid", + "required": true, + "schema": { + "type": "string" + }, + "example": "DTXSID7020182" + }, + { + "name": "model", + "in": "query", + "description": "model", + "required": true, + "schema": { + "type": "string" + }, + "example": "CERAPP " + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/BioactivityModel" + } + } + } } + } }, - "/bioactivity/data/search/by-dtxsid/{dtxsid}": { - "get": { - "tags": [ - "Bioactivity Data Resource" - ], - "summary": "Get data by DTXSID", - "description": "Return data for a given DTXSID. There is an available projection aligned with what's available on the CCD ToxCast Summary plot: toxcast-summary-plot. If no projection is specified, a default BioactivityDataAll projection will be returned.", - "operationId": "dataByDtxsid", - "parameters": [ - { - "name": "dtxsid", - "in": "path", - "description": "DSSTox Substance Identifier", - "required": true, - "schema": { - "type": "string" - }, - "example": "DTXSID7020182" - }, - { - "name": "projection", - "in": "query", - "description": "Specifies if projection is used. Option: toxcast-summary-plot. If omitted, the default BioactivityDataAll data is returned.", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "type": "string", - "oneOf": [ - { - "$ref": "#/components/schemas/BioactivityDataAll" - } - ] - } - } - } - } - } - }, - "security": [ + "security": [ + { + "api_key": [] + } + ] + } + }, + "/bioactivity/data/summary/search/by-tissue/": { + "get": { + "tags": [ + "Bioactivity Data Resource" + ], + "summary": "Get summary data by DTXSID and assay tissue origin", + "description": "return summary data for given DTXSID and the assay format's tissue origin", + "operationId": "summaryByDtxsidAndTissue", + "parameters": [ + { + "name": "dtxsid", + "in": "query", + "description": "DSSTox Substance Identifier", + "required": true, + "schema": { + "type": "string" + }, + "example": "DTXSID7024241" + }, + { + "name": "tissue", + "in": "query", + "description": "assay format's tissue of origin", + "required": true, + "schema": { + "type": "string" + }, + "example": "liver" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "string", + "oneOf": [ { - "api_key": [] + "$ref": "#/components/schemas/SummaryByTissue" } - ] + ] + } + } } + } }, - "/bioactivity/data/search/by-aeid/{aeid}": { - "get": { - "tags": [ - "Bioactivity Data Resource" - ], - "summary": "Get data by AEID", - "description": "Return data by ToxCast assay component endpoint ID (AEID)", - "operationId": "dataByAeid", - "parameters": [ - { - "name": "aeid", - "in": "path", - "description": "ToxCast assay component endpoint ID (AEID)", - "required": true, - "schema": { - "type": "integer", - "format": "int32" - }, - "example": 3032 - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/BioactivityDataAll" - } - } - } - } - } - }, - "security": [ + "security": [ + { + "api_key": [] + } + ] + } + }, + "/bioactivity/data/summary/search/by-dtxsid/{dtxsid}": { + "get": { + "tags": [ + "Bioactivity Data Resource" + ], + "summary": "Get summary data by DTXSID", + "description": "return summary of active hits and total multi- and single-concentration assays tested for given DTXSID", + "operationId": "summaryByDtxsid", + "parameters": [ + { + "name": "dtxsid", + "in": "path", + "description": "DSSTox Substance Identifier", + "required": true, + "schema": { + "type": "string" + }, + "example": "DTXSID9026974" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "string", + "oneOf": [ { - "api_key": [] + "$ref": "#/components/schemas/ChemicalAgg" } - ] + ] + } + } } + } }, - "/bioactivity/data/aed/search/by-dtxsid/{dtxsid}": { - "get": { - "tags": [ - "Bioactivity Data Resource" - ], - "summary": "Get AED data by DTXSID", - "description": "return administered equivalent dose (AED) data derived from ToxCast in vitro bioactivity data for given DTXSID", - "operationId": "getAedDataByDtxsid", - "parameters": [ - { - "name": "dtxsid", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "example": "DTXSID5021209" - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AedData" - } - } - } - } - }, - "security": [ + "security": [ + { + "api_key": [] + } + ] + } + }, + "/bioactivity/data/summary/search/by-aeid/{aeid}": { + "get": { + "tags": [ + "Bioactivity Data Resource" + ], + "summary": "Get summary data by AEID", + "description": "return summary of active hits and total multi- and single-concentration chemicals tested for given ToxCast assay component endpoint ID (AEID)", + "operationId": "summaryByAeid", + "parameters": [ + { + "name": "aeid", + "in": "path", + "description": "ToxCast assay component endpoint ID (AEID)", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + }, + "example": 3032 + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "string", + "oneOf": [ { - "api_key": [] + "$ref": "#/components/schemas/AssayAgg" } - ] + ] + } + } } + } }, - "/bioactivity/assay/single-conc/search/by-aeid/{aeid}": { - "get": { - "tags": [ - "Bioactivity Assay Resource" - ], - "summary": "Get single conc data by AEID", - "description": "return single concentration screening data for requested ToxCast assay component endpoint ID (AEID)", - "operationId": "singleConcDataByAeid", - "parameters": [ - { - "name": "aeid", - "in": "path", - "description": "ToxCast assay component endpoint ID", - "required": true, - "schema": { - "type": "integer", - "format": "int32" - }, - "example": 3032 - }, - { - "name": "projection", - "in": "query", - "required": false, - "schema": { - "type": "string", - "default": "single-conc" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "string", - "oneOf": [ - { - "$ref": "#/components/schemas/CcdSingleConcData" - } - ] - } - } - } - } - }, - "security": [ - { - "api_key": [] - } - ] + "security": [ + { + "api_key": [] + } + ] + } + }, + "/bioactivity/data/search/by-spid/{spid}": { + "get": { + "tags": [ + "Bioactivity Data Resource" + ], + "summary": "Get data by SPID", + "description": "return data for given sample ID (SPID)", + "operationId": "dataBySpid", + "parameters": [ + { + "name": "spid", + "in": "path", + "description": "sample ID (SPID)", + "required": true, + "schema": { + "type": "string" + }, + "example": "EPAPLT0232A03" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/BioactivityDataAll" + } + } + } } + } }, - "/bioactivity/assay/search/by-gene/{geneSymbol}": { - "get": { - "tags": [ - "Bioactivity Assay Resource" - ], - "summary": "Get assay summary by gene symbol", - "description": "Return assay summary data, including percentage of single and multiple-concentration screening actives, for applicable assays for requested offical gene symbol.", - "operationId": "assayEndpointsListByGene", - "parameters": [ - { - "name": "geneSymbol", - "in": "path", - "description": "Gene Symbol", - "required": true, - "schema": { - "type": "string" - }, - "example": "TUBA1A" - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "string", - "oneOf": [ - { - "$ref": "#/components/schemas/AssayEndpointsList" - } - ] - } - } - } - } - }, - "security": [ + "security": [ + { + "api_key": [] + } + ] + } + }, + "/bioactivity/data/search/by-m4id/{m4id}": { + "get": { + "tags": [ + "Bioactivity Data Resource" + ], + "summary": "Get data by M4ID", + "description": "return data for given Level 4 ID (M4ID), corresponding to the individual modeled endpoint-sample concentration-response", + "operationId": "dataByM4Id", + "parameters": [ + { + "name": "m4id", + "in": "path", + "description": "M4ID", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + }, + "example": 7826737 + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "string", + "oneOf": [ { - "api_key": [] + "$ref": "#/components/schemas/BioactivityDataAll" } - ] + ] + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/bioactivity/data/search/by-dtxsid/{dtxsid}": { + "get": { + "tags": [ + "Bioactivity Data Resource" + ], + "summary": "Get data by DTXSID", + "description": "Return data for a given DTXSID. There is an available projection aligned with what's available on the CCD ToxCast Summary plot: toxcast-summary-plot. If no projection is specified, a default BioactivityDataAll projection will be returned.", + "operationId": "dataByDtxsid", + "parameters": [ + { + "name": "dtxsid", + "in": "path", + "description": "DSSTox Substance Identifier", + "required": true, + "schema": { + "type": "string" + }, + "example": "DTXSID7020182" + }, + { + "name": "projection", + "in": "query", + "description": "Specifies if projection is used. Option: toxcast-summary-plot. If omitted, the default BioactivityDataAll data is returned.", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "string", + "oneOf": [ + { + "$ref": "#/components/schemas/BioactivityDataAll" + } + ] + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/bioactivity/data/search/by-aeid/{aeid}": { + "get": { + "tags": [ + "Bioactivity Data Resource" + ], + "summary": "Get data by AEID", + "description": "Return data by ToxCast assay component endpoint ID (AEID)", + "operationId": "dataByAeid", + "parameters": [ + { + "name": "aeid", + "in": "path", + "description": "ToxCast assay component endpoint ID (AEID)", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + }, + "example": 3032 + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/BioactivityDataAll" + } + } + } } + } }, - "/bioactivity/assay/search/by-endpoint/": { - "get": { - "tags": [ - "Bioactivity Assay Resource" - ], - "summary": "Get AEID by assay component endpoint name", - "operationId": "aeidByAssayEndpointName", - "parameters": [ + "security": [ + { + "api_key": [] + } + ] + } + }, + "/bioactivity/data/aed/search/by-dtxsid/{dtxsid}": { + "get": { + "tags": [ + "Bioactivity Data Resource" + ], + "summary": "Get AED data by DTXSID", + "description": "return administered equivalent dose (AED) data derived from ToxCast in vitro bioactivity data for given DTXSID", + "operationId": "getAedDataByDtxsid", + "parameters": [ + { + "name": "dtxsid", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "example": "DTXSID5021209" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AedData" + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/bioactivity/assay/single-conc/search/by-aeid/{aeid}": { + "get": { + "tags": [ + "Bioactivity Assay Resource" + ], + "summary": "Get single conc data by AEID", + "description": "return single concentration screening data for requested ToxCast assay component endpoint ID (AEID)", + "operationId": "singleConcDataByAeid", + "parameters": [ + { + "name": "aeid", + "in": "path", + "description": "ToxCast assay component endpoint ID", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + }, + "example": 3032 + }, + { + "name": "projection", + "in": "query", + "required": false, + "schema": { + "type": "string", + "default": "single-conc" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "string", + "oneOf": [ { - "name": "endpoint", - "in": "query", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/schemas/CcdSingleConcData" } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "integer", - "format": "int64" - } - } - } - } - }, - "security": [ + ] + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/bioactivity/assay/search/by-gene/{geneSymbol}": { + "get": { + "tags": [ + "Bioactivity Assay Resource" + ], + "summary": "Get assay summary by gene symbol", + "description": "Return assay summary data, including percentage of single and multiple-concentration screening actives, for applicable assays for requested offical gene symbol.", + "operationId": "assayEndpointsListByGene", + "parameters": [ + { + "name": "geneSymbol", + "in": "path", + "description": "Gene Symbol", + "required": true, + "schema": { + "type": "string" + }, + "example": "TUBA1A" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "string", + "oneOf": [ { - "api_key": [] + "$ref": "#/components/schemas/AssayEndpointsList" } - ] + ] + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/bioactivity/assay/search/by-endpoint/": { + "get": { + "tags": [ + "Bioactivity Assay Resource" + ], + "summary": "Get AEID by assay component endpoint name", + "operationId": "aeidByAssayEndpointName", + "parameters": [ + { + "name": "endpoint", + "in": "query", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "integer", + "format": "int64" + } + } } + } }, - "/bioactivity/assay/search/by-aeid/{aeid}": { - "get": { - "tags": [ - "Bioactivity Assay Resource" - ], - "summary": "Get assay annotations by AEID", - "description": "return assay annotations by ToxCast assay component endpoint ID (AEID) based on the specified projection. Available projections: ccd-assay-annotation, ccd-assay-gene, ccd-assay-citations, ccd-assay-tcpl, ccd-assay-reagents, assay-all. If no projection is specified, the full view of assay annotations will be returned by default.", - "operationId": "assayByAeid", - "parameters": [ + "security": [ + { + "api_key": [] + } + ] + } + }, + "/bioactivity/assay/search/by-aeid/{aeid}": { + "get": { + "tags": [ + "Bioactivity Assay Resource" + ], + "summary": "Get assay annotations by AEID", + "description": "return assay annotations by ToxCast assay component endpoint ID (AEID) based on the specified projection. Available projections: ccd-assay-annotation, ccd-assay-gene, ccd-assay-citations, ccd-assay-tcpl, ccd-assay-reagents, assay-all. If no projection is specified, the full view of assay annotations will be returned by default.", + "operationId": "assayByAeid", + "parameters": [ + { + "name": "aeid", + "in": "path", + "description": "ToxCast assay component endpoint ID", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + }, + "example": 3032 + }, + { + "name": "projection", + "in": "query", + "description": "Specifies which projection to use. Options: ccd-assay-annotation, ccd-assay-gene, ccd-assay-citations, ccd-assay-tcpl, ccd-assay-reagents, assay-all. If omitted, the full assay data is returned.", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "string", + "oneOf": [ { - "name": "aeid", - "in": "path", - "description": "ToxCast assay component endpoint ID", - "required": true, - "schema": { - "type": "integer", - "format": "int32" - }, - "example": 3032 + "$ref": "#/components/schemas/AssayAnnotation" }, { - "name": "projection", - "in": "query", - "description": "Specifies which projection to use. Options: ccd-assay-annotation, ccd-assay-gene, ccd-assay-citations, ccd-assay-tcpl, ccd-assay-reagents, assay-all. If omitted, the full assay data is returned.", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "string", - "oneOf": [ - { - "$ref": "#/components/schemas/AssayAnnotation" - }, - { - "$ref": "#/components/schemas/CcDAssayAnnotation" - }, - { - "$ref": "#/components/schemas/CcdAssayGene" - }, - { - "$ref": "#/components/schemas/CcdAssayCitation" - }, - { - "$ref": "#/components/schemas/CcdTcplData" - }, - { - "$ref": "#/components/schemas/CcdReagents" - } - ] - } - } - } + "$ref": "#/components/schemas/CcDAssayAnnotation" }, - "400": { - "description": "Invalid projection type", - "content": { - "application/json": { - "schema": { - "type": "string", - "oneOf": [ - { - "$ref": "#/components/schemas/ProblemDetail" - } - ] - } - } - } - }, - "404": { - "description": "No data found for the given AEID", - "content": { - "application/json": { - "schema": { - "type": "string", - "oneOf": [ - { - "$ref": "#/components/schemas/ProblemDetail" - } - ] - } - } - } - } - }, - "security": [ - { - "api_key": [] - } - ] - } - }, - "/bioactivity/assay/count": { - "get": { - "tags": [ - "Bioactivity Assay Resource" - ], - "summary": "Get total assay count", - "operationId": "assayCount", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "integer", - "format": "int64" - } - } - } - } - }, - "security": [ { - "api_key": [] - } - ] - } - }, - "/bioactivity/assay/chemicals/search/by-aeid/{aeid}": { - "get": { - "tags": [ - "Bioactivity Assay Resource" - ], - "summary": "Get DTXSID list by AEID", - "description": "return list of chemicals (DTXSIDs) tested by ToxCast assay component endpoint ID (AEID).", - "operationId": "chemicalsByAeid", - "parameters": [ + "$ref": "#/components/schemas/CcdAssayGene" + }, { - "name": "aeid", - "in": "path", - "description": "ToxCast assay component endpoint ID", - "required": true, - "schema": { - "type": "integer", - "format": "int32" - }, - "example": 3032 + "$ref": "#/components/schemas/CcdAssayCitation" }, { - "name": "projection", - "in": "query", - "required": false, - "schema": { - "type": "string", - "default": "dtxsidsonly" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "string", - "oneOf": [ - { - "type": "string" - } - ] - } - } - } - } - }, - "security": [ + "$ref": "#/components/schemas/CcdTcplData" + }, { - "api_key": [] + "$ref": "#/components/schemas/CcdReagents" } - ] + ] + } + } } - }, - "/bioactivity/assay/": { - "get": { - "tags": [ - "Bioactivity Assay Resource" - ], - "summary": "Get all assay annotations", - "operationId": "allAssays", - "parameters": [ + }, + "400": { + "description": "Invalid projection type", + "content": { + "application/json": { + "schema": { + "type": "string", + "oneOf": [ { - "name": "projection", - "in": "query", - "required": false, - "schema": { - "type": "string", - "default": "assay-all" - } + "$ref": "#/components/schemas/ProblemDetail" } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "string", - "oneOf": [ - { - "$ref": "#/components/schemas/AssayAnnotation" - } - ] - } - } - } - } - }, - "security": [ + ] + } + } + } + }, + "404": { + "description": "No data found for the given AEID", + "content": { + "application/json": { + "schema": { + "type": "string", + "oneOf": [ { - "api_key": [] + "$ref": "#/components/schemas/ProblemDetail" } - ] + ] + } + } } + } }, - "/bioactivity/aop/search/by-toxcast-aeid/{toxcastAeid}": { - "get": { - "tags": [ - "CCD AOP Data Resource" - ], - "summary": "Get AOP data by ToxCast AEID", - "description": "Return ToxCast-mapped AOP data for a given ToxCast assay component endpoint ID (AEID)", - "operationId": "dataByToxcastAeid", - "parameters": [ - { - "name": "toxcastAeid", - "in": "path", - "description": "ToxCast AEID", - "required": true, - "schema": { - "type": "integer", - "format": "int32" - }, - "example": 63 - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AOP" - } - } - } - } - } - }, - "security": [ - { - "api_key": [] - } - ] + "security": [ + { + "api_key": [] + } + ] + } + }, + "/bioactivity/assay/count": { + "get": { + "tags": [ + "Bioactivity Assay Resource" + ], + "summary": "Get total assay count", + "operationId": "assayCount", + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "integer", + "format": "int64" + } + } } + } }, - "/bioactivity/aop/search/by-event-number/{eventNumber}": { - "get": { - "tags": [ - "CCD AOP Data Resource" - ], - "summary": "Get AOP data by Key Event", - "description": "Return ToxCast-mapped AOP data for a given Key Event (KE) number", - "operationId": "dataByEventNumber", - "parameters": [ - { - "name": "eventNumber", - "in": "path", - "description": "Key Event Number", - "required": true, - "schema": { - "type": "integer", - "format": "int32" - }, - "example": 18 - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AOP" - } - } - } - } - } - }, - "security": [ + "security": [ + { + "api_key": [] + } + ] + } + }, + "/bioactivity/assay/chemicals/search/by-aeid/{aeid}": { + "get": { + "tags": [ + "Bioactivity Assay Resource" + ], + "summary": "Get DTXSID list by AEID", + "description": "return list of chemicals (DTXSIDs) tested by ToxCast assay component endpoint ID (AEID).", + "operationId": "chemicalsByAeid", + "parameters": [ + { + "name": "aeid", + "in": "path", + "description": "ToxCast assay component endpoint ID", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + }, + "example": 3032 + }, + { + "name": "projection", + "in": "query", + "required": false, + "schema": { + "type": "string", + "default": "dtxsidsonly" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "string", + "oneOf": [ { - "api_key": [] + "type": "string" } - ] + ] + } + } } + } }, - "/bioactivity/aop/search/by-entrez-gene-id/{entrezGeneId}": { - "get": { - "tags": [ - "CCD AOP Data Resource" - ], - "summary": "Get AOP data by Entrez Gene ID", - "description": "Return ToxCast-mapped AOP data for a given Entrez Gene ID", - "operationId": "dataByEntrezGeneId", - "parameters": [ - { - "name": "entrezGeneId", - "in": "path", - "description": "Entrez Gene Id", - "required": true, - "schema": { - "type": "integer", - "format": "int32" - }, - "example": 196 - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AOP" - } - } - } - } - } - }, - "security": [ + "security": [ + { + "api_key": [] + } + ] + } + }, + "/bioactivity/assay/": { + "get": { + "tags": [ + "Bioactivity Assay Resource" + ], + "summary": "Get all assay annotations", + "operationId": "allAssays", + "parameters": [ + { + "name": "projection", + "in": "query", + "required": false, + "schema": { + "type": "string", + "default": "assay-all" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "string", + "oneOf": [ { - "api_key": [] + "$ref": "#/components/schemas/AssayAnnotation" } - ] + ] + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/bioactivity/aop/search/by-toxcast-aeid/{toxcastAeid}": { + "get": { + "tags": [ + "CCD AOP Data Resource" + ], + "summary": "Get AOP data by ToxCast AEID", + "description": "Return ToxCast-mapped AOP data for a given ToxCast assay component endpoint ID (AEID)", + "operationId": "dataByToxcastAeid", + "parameters": [ + { + "name": "toxcastAeid", + "in": "path", + "description": "ToxCast AEID", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + }, + "example": 63 + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AOP" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/bioactivity/aop/search/by-event-number/{eventNumber}": { + "get": { + "tags": [ + "CCD AOP Data Resource" + ], + "summary": "Get AOP data by Key Event", + "description": "Return ToxCast-mapped AOP data for a given Key Event (KE) number", + "operationId": "dataByEventNumber", + "parameters": [ + { + "name": "eventNumber", + "in": "path", + "description": "Key Event Number", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + }, + "example": 18 + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AOP" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/bioactivity/aop/search/by-entrez-gene-id/{entrezGeneId}": { + "get": { + "tags": [ + "CCD AOP Data Resource" + ], + "summary": "Get AOP data by Entrez Gene ID", + "description": "Return ToxCast-mapped AOP data for a given Entrez Gene ID", + "operationId": "dataByEntrezGeneId", + "parameters": [ + { + "name": "entrezGeneId", + "in": "path", + "description": "Entrez Gene Id", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + }, + "example": 196 + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AOP" + } + } + } } + } }, - "/bioactivity/analyticalqc/search/by-dtxsid/{dtxsid}": { - "get": { - "tags": [ - "Analytical QC Resource" - ], - "summary": "Get analytical QC data by DTXSID", - "description": "return analytical QC data for requested DTXSID", - "operationId": "findByDsstoxSubstanceId", - "parameters": [ + "security": [ + { + "api_key": [] + } + ] + } + }, + "/bioactivity/analyticalqc/search/by-dtxsid/{dtxsid}": { + "get": { + "tags": [ + "Analytical QC Resource" + ], + "summary": "Get analytical QC data by DTXSID", + "description": "return analytical QC data for requested DTXSID", + "operationId": "findByDsstoxSubstanceId", + "parameters": [ + { + "name": "dtxsid", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "string", + "oneOf": [ { - "name": "dtxsid", - "in": "path", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/schemas/AnalyticalQC" } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "string", - "oneOf": [ - { - "$ref": "#/components/schemas/AnalyticalQC" - } - ] - } - } - } - }, - "404": { - "description": "Data not found", - "content": { - "application/json": { - "schema": { - "type": "string", - "oneOf": [ - { - "$ref": "#/components/schemas/ProblemDetail" - } - ] - } - } - } + ] + } + } + } + }, + "404": { + "description": "Data not found", + "content": { + "application/json": { + "schema": { + "type": "string", + "oneOf": [ + { + "$ref": "#/components/schemas/ProblemDetail" } + ] } + } } + } } - }, - "components": { - "schemas": { - "BioactivityDataAll": { - "type": "object", - "properties": { - "chnm": { - "type": "string" - }, - "dtxsid": { - "type": "string" - }, - "spid": { - "type": "string" - }, - "stkc": { - "type": "number", - "format": "double" - }, - "respMin": { - "type": "number", - "format": "double" - }, - "maxMean": { - "type": "number", - "format": "double" - }, - "nrep": { - "type": "number", - "format": "double" - }, - "nconc": { - "type": "integer", - "format": "int32" - }, - "fitc": { - "type": "integer", - "format": "int32" - }, - "actp": { - "type": "number", - "format": "double" - }, - "m4id": { - "type": "integer", - "format": "int64" - }, - "concMin": { - "type": "number", - "format": "double" - }, - "bmad": { - "type": "number", - "format": "double" - }, - "npts": { - "type": "integer", - "format": "int32" - }, - "chid": { - "type": "integer", - "format": "int32" - }, - "casn": { - "type": "string" - }, - "maxMed": { - "type": "number", - "format": "double" - }, - "chidRep": { - "type": "integer", - "format": "int32" - }, - "hitc": { - "type": "number", - "format": "double" - }, - "concMax": { - "type": "number", - "format": "double" - }, - "modl": { - "type": "string" - }, - "coff": { - "type": "number", - "format": "double" - }, - "respMax": { - "type": "number", - "format": "double" - }, - "m5id": { - "type": "integer", - "format": "int64" - }, - "aeid": { - "type": "integer", - "format": "int64" - }, - "maxMeanConc": { - "type": "number", - "format": "double" - }, - "maxMedConc": { - "type": "number", - "format": "double" - }, - "nmedGtblPos": { - "type": "integer", - "format": "int32" - }, - "nmedGtblNeg": { - "type": "integer", - "format": "int32" - }, - "modelType": { - "type": "integer", - "format": "int32" - }, - "mc4Param": { - "type": "object", - "additionalProperties": { - "type": "number" - } - }, - "stkcUnit": { - "type": "string" - }, - "mc6Param": { - "$ref": "#/components/schemas/Mc6Param" - }, - "mc5Param": { - "type": "object", - "additionalProperties": { - "type": "number" - } - }, - "mc3Param": { - "$ref": "#/components/schemas/Mc3Param" - }, - "testedConcUnit": { - "type": "string" - } - } - }, - "Mc3Param": { - "type": "object", - "properties": { - "conc": { - "type": "array", - "items": { - "type": "number" - } - }, - "resp": { - "type": "array", - "items": { - "type": "number" - } - } - } - }, - "Mc6Param": { - "type": "object", - "properties": { - "flag": { - "type": "array", - "items": { - "type": "string" - } - }, - "mc6MthdId": { - "type": "array", - "items": { - "type": "integer", - "format": "int32" - } - } - } - }, - "AedData": { - "type": "object", - "properties": { - "dtxsid": { - "type": "string" - }, - "preferredName": { - "type": "string" - }, - "aeid": { - "type": "integer", - "format": "int32" - }, - "aenm": { - "type": "string" - }, - "aedVal": { - "type": "array", - "items": { - "type": "number", - "format": "double" - } - }, - "aedType": { - "type": "array", - "items": { - "type": "string" - } - }, - "httkModel": { - "type": "array", - "items": { - "type": "string" - } - }, - "aedValUnit": { - "type": "array", - "items": { - "type": "string" - } - }, - "httkVersion": { - "type": "array", - "items": { - "type": "string" - } - }, - "potencyValType": { - "type": "array", - "items": { - "type": "string" - } - }, - "invitrodbVersion": { - "type": "array", - "items": { - "type": "string" - } - }, - "interindividualVarPerc": { - "type": "array", - "items": { - "type": "number", - "format": "double" - } - } - } - }, - "AssayAll": { - "type": "object", - "properties": { - "assayDescs": { - "writeOnly": true - }, - "assayname": { - "writeOnly": true - }, - "asid": { - "type": "integer", - "format": "int32" - }, - "aid": { - "type": "integer", - "format": "int32" - }, - "acid": { - "type": "integer", - "format": "int32" - }, - "gene": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Gene" - } - }, - "tissue": { - "type": "string" - }, - "assayComponentName": { - "type": "string" - }, - "assayFormatTypeSub": { - "type": "string" - }, - "cellViabilityAssay": { - "type": "integer", - "format": "int32" - }, - "keyPositiveControl": { - "type": "string" - }, - "assayFunctionType": { - "type": "string" - }, - "assayComponentDesc": { - "type": "string" - }, - "cellFreeComponentSource": { - "type": "string" - }, - "intendedTargetTypeSub": { - "type": "string" - }, - "intendedTargetFamily": { - "type": "string" - }, - "parameterReadoutType": { - "type": "string" - }, - "contentReadoutType": { - "type": "string" - }, - "technologicalTargetType": { - "type": "string" - }, - "intendedTargetFamilySub": { - "type": "string" - }, - "biologicalProcessTarget": { - "type": "string" - }, - "detectionTechnology": { - "type": "string" - }, - "assayDesignTypeSub": { - "type": "string" - }, - "intendedTargetType": { - "type": "string" - }, - "detectionTechnologyType": { - "type": "string" - }, - "keyAssayReagentType": { - "type": "string" - }, - "normalizedDataType": { - "type": "string" - }, - "assaySourceLongName": { - "type": "string" - }, - "aeid": { - "type": "integer", - "format": "int64" - }, - "assayComponentEndpointDesc": { - "type": "string" - }, - "assayComponentEndpointName": { - "type": "string" - }, - "organismId": { - "type": "integer", - "format": "int32" - }, - "organism": { - "type": "string" - }, - "burstAssay": { - "type": "integer", - "format": "int32" - }, - "signalDirection": { - "type": "string" - }, - "assayDesignType": { - "type": "string" - }, - "keyAssayReagent": { - "type": "string" - }, - "timepointHr": { - "type": "number", - "format": "double" - }, - "assayDesc": { - "type": "string" - }, - "cellGrowthMode": { - "type": "string" - }, - "assayFootprint": { - "type": "string" - }, - "dilutionSolvent": { - "type": "string" - }, - "assayList": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AssayList" - } - }, - "citations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Citation" - } - }, - "cellFormat": { - "type": "string" - }, - "assaySourceName": { - "type": "string" - }, - "assaySourceDesc": { - "type": "string" - }, - "assayFormatType": { - "type": "string" - }, - "cellShortName": { - "type": "string" - }, - "assayName": { - "type": "string" - }, - "assayComponentTargetDesc": { - "type": "string" - }, - "detectionTechnologyTypeSub": { - "type": "string" - }, - "technologicalTargetTypeSub": { - "type": "string" - }, - "dilutionSolventPercentMax": { - "type": "number", - "format": "double" - }, - "technologicalTargetTypes": { - "writeOnly": true - } - } - }, - "AssayList": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "description": { - "type": "string" - } - } - }, - "Citation": { - "type": "object", - "properties": { - "doi": { - "type": "string" - }, - "url": { - "type": "string" - }, - "pmid": { - "type": "integer", - "format": "int32" - }, - "title": { - "type": "string" - }, - "author": { - "type": "string" - }, - "citation": { - "type": "string" - }, - "otherId": { - "type": "string" - }, - "citationId": { - "type": "integer", - "format": "int32" - }, - "otherSource": { - "type": "string" - } - } - }, - "Gene": { - "type": "object", - "properties": { - "geneId": { - "type": "integer", - "format": "int32" - }, - "geneName": { - "type": "string" - }, - "description": { - "type": "string" - }, - "geneSymbol": { - "type": "string" - }, - "organismId": { - "type": "integer", - "format": "int32" - }, - "trackStatus": { - "type": "string" - }, - "entrezGeneId": { - "type": "integer", - "format": "int32" - }, - "officialSymbol": { - "type": "string" - }, - "officialFullName": { - "type": "string" - }, - "uniprotAccessionNumber": { - "type": "string" - } - } - }, - "SearchAssay": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int32" - }, - "aeid": { - "type": "integer", - "format": "int32" - }, - "searchName": { - "type": "string", - "maxLength": 50, - "minLength": 0 - }, - "searchValue": { - "type": "string", - "maxLength": 200, - "minLength": 0 - }, - "searchValueDesc": { - "type": "string" - }, - "modifiedValue": { - "type": "string" - } - }, - "required": [ - "aeid", - "id" - ] - }, - "ProblemDetail": { - "type": "object", - "properties": { - "type": { - "type": "string", - "format": "uri" - }, - "title": { - "type": "string" - }, - "status": { - "type": "integer", - "format": "int32" - }, - "detail": { - "type": "string" - }, - "instance": { - "type": "string", - "format": "uri" - }, - "properties": { - "type": "object", - "additionalProperties": {} - } - } - }, - "BioactivityModel": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int32" - }, - "dtxsid": { - "type": "string" - }, - "model": { - "type": "string" - }, - "receptor": { - "type": "string" - }, - "agonist": { - "type": "string" - }, - "antagonist": { - "type": "string" - }, - "binding": { - "type": "string" - }, - "modelDesc": { - "type": "string" - } - } - }, - "SummaryByTissue": { - "type": "object", - "properties": { - "chemicalName": { - "type": "string" - }, - "dtxsid": { - "type": "string" - }, - "tissue": { - "type": "string" - }, - "intendedTargetFamily": { - "type": "string" - }, - "hitCall": { - "type": "string" - }, - "ac50": { - "type": "number", - "format": "float" - }, - "logAC50": { - "type": "number", - "format": "float" - }, - "cutOff": { - "type": "number", - "format": "float" - }, - "acc": { - "type": "number", - "format": "float" - }, - "maxMedConc": { - "type": "number", - "format": "float" - }, - "continuousHitCall": { - "type": "number", - "format": "float" - } - } - }, - "ChemicalAgg": { - "type": "object", - "properties": { - "dtxsid": { - "type": "string", - "maxLength": 255, - "minLength": 0 - }, - "activeMc": { - "type": "integer", - "format": "int32" - }, - "totalMc": { - "type": "integer", - "format": "int32" - }, - "activeSc": { - "type": "integer", - "format": "int32" - }, - "totalSc": { - "type": "integer", - "format": "int32" - }, - "cytotoxMedianRaw": { - "type": "number", - "format": "float" - }, - "cytotoxMad": { - "type": "number", - "format": "float" - }, - "globalMad": { - "type": "number", - "format": "float" - }, - "cytotoxMedianLog": { - "type": "number", - "format": "float" - }, - "cytotoxMedianUm": { - "type": "number", - "format": "float" - }, - "cytotoxLowerUm": { - "type": "number", - "format": "float" - }, - "cytotoxLowerLog": { - "type": "number", - "format": "float" - }, - "ntested": { - "type": "number", - "format": "float" - }, - "nhit": { - "type": "number", - "format": "float" - } - } - }, - "AssayAgg": { - "type": "object", - "properties": { - "aeid": { - "type": "integer", - "format": "int64", - "description": "Assay component endpoint ID" - }, - "activeMc": { - "type": "integer", - "format": "int32", - "maximum": 23, - "minimum": 0 - }, - "totalMc": { - "type": "integer", - "format": "int64" - }, - "activeSc": { - "type": "integer", - "format": "int32", - "maximum": 23, - "minimum": 0 - }, - "totalSc": { - "type": "integer", - "format": "int64" - } - } - }, - "CcdSingleConcData": { - "type": "object", - "properties": { - "endpointName": { - "type": "string" - }, - "maxMedVal": { - "type": "number", - "format": "double" - }, - "dtxsid": { - "type": "string" - }, - "bmad": { - "type": "number", - "format": "double" - }, - "casn": { - "type": "string" - }, - "hitc": { - "type": "number", - "format": "double" - }, - "coff": { - "type": "number", - "format": "double" - }, - "s2id": { - "type": "integer", - "format": "int64" - }, - "aeid": { - "type": "integer", - "format": "int32" - }, - "preferredName": { - "type": "string" - } - } - }, - "AssayEndpointsList": { - "type": "object", - "properties": { - "aeid": { - "type": "integer", - "format": "int64" - }, - "assayComponentEndpointDesc": { - "type": "string" - }, - "assayComponentEndpointName": { - "type": "string" - }, - "geneSymbol": { - "type": "string" - }, - "singleConcActive": { - "type": "string" - }, - "multiConcActives": { - "type": "string" - } - } - }, - "AssayAnnotation": { - "type": "object", - "description": "US EPA's Toxicity Forecaster (ToxCast) program makes invitro medium- and high-throughput screening assay data publicly available for prioritization and hazard characterization. Given ToxCast includes a heterogeneous set of assays across a diverse biological space, annotations in the database help flexibly aggregate and differentiate processed data. The definition of an “assay” is, in ToxCast, broken into 4 assay elements: assay source: the vendor/origination of the data, assay: the procedure to generate the component data, assay component: the raw data readout(s), assay component endpoint: the normalized component data. The assay element annotations are often short in a standardized format or use a controlled term list. Assay” resource endpoints provide assay metadata for specific or all invitrodb ‘aeids’ (assay endpoint ids). These include annotations from invitrodb’s assay, assay_component, assay_component_endpoint, assay_list, assay_source, and gene tables, all returned in a by-aeid format. Regular ToxCast/invitrodb users may find it easier to use the tcpl R package, which has integrated to make API data retrievable in a familiar format. See the tcpl vignette regarding data retrieval via API for more information.", - "properties": { - "aeid": { - "type": "integer", - "format": "int64", - "description": "Assay component endpoint ID" - }, - "assayComponentEndpointName": { - "type": "string", - "description": "Assay component endpoint name (abbreviated 'aenm' within the package)", - "maxLength": 255, - "minLength": 0 - }, - "assayComponentEndpointDesc": { - "type": "string", - "description": "Assay component endpoint description" - }, - "assayFunctionType": { - "type": "string", - "description": "Description of targeted mechanism and the purpose of the analyzed readout in relation to others from the same assay", - "maxLength": 255, - "minLength": 0 - }, - "normalizedDataType": { - "type": "string", - "description": "Normalization approach for which the data is displayed", - "maxLength": 255, - "minLength": 0 - }, - "burstAssay": { - "type": "integer", - "format": "int32", - "description": "Indicator if endpoint is included in the burst distribution (1) or not (0); Burst phenomenon can describe confounding activity, such as cytotoxicity due to non-specific activation of many targets at certain concentrations" - }, - "keyPositiveControl": { - "type": "string", - "description": "Tested chemical sample expected to produce activity; Used to assess assay validity", - "maxLength": 255, - "minLength": 0 - }, - "signalDirection": { - "type": "string", - "description": "Directionality of raw data signals from assay (gain or loss); Defines analysis direction", - "maxLength": 255, - "minLength": 0 - }, - "intendedTargetType": { - "type": "string", - "description": "General group of intended targets measured", - "maxLength": 255, - "minLength": 0 - }, - "intendedTargetTypeSub": { - "type": "string", - "description": "Specific subgroup of intended targets measured", - "maxLength": 255, - "minLength": 0 - }, - "intendedTargetFamily": { - "type": "string", - "description": "Family of intended target measured; Populated on ToxCast chemical activity plot within CompTox dashboard", - "maxLength": 255, - "minLength": 0 - }, - "intendedTargetFamilySub": { - "type": "string", - "description": "Specific subfamily of intended target measured", - "maxLength": 255, - "minLength": 0 - }, - "cellViabilityAssay": { - "type": "integer", - "format": "int32", - "description": "Indicator of the impact of cytotoxicity in confounding (1) or no cytotoxic impact (0)" - }, - "acid": { - "type": "integer", - "format": "int32", - "description": "Assay component ID" - }, - "assayComponentName": { - "type": "string", - "description": "Assay component name (abbreviated 'acnm' within the package)", - "maxLength": 255, - "minLength": 0 - }, - "assayComponentDesc": { - "type": "string", - "description": "Assay component description" - }, - "assayComponentTargetDesc": { - "type": "string", - "description": "Assay component target description. Generally includes information about mechanism of action with assay target, how disruption is detected, or significance of target disruption." - }, - "parameterReadoutType": { - "type": "string", - "description": "Description of parameters measured", - "maxLength": 255, - "minLength": 0 - }, - "assayDesignType": { - "type": "string", - "description": "General description of the biological or physical process is translated into a detectable signal by assay mechanism", - "maxLength": 255, - "minLength": 0 - }, - "assayDesignTypeSub": { - "type": "string", - "description": "Specific description of method through which a biological or physical process is translated into a detectable signal measured", - "maxLength": 255, - "minLength": 0 - }, - "biologicalProcessTarget": { - "type": "string", - "description": "General biological process being chemically disrupted", - "maxLength": 255, - "minLength": 0 - }, - "detectionTechnologyType": { - "type": "string", - "description": "General description of assay platform or detection signals measured", - "maxLength": 255, - "minLength": 0 - }, - "detectionTechnologyTypeSub": { - "type": "string", - "description": "Description of signals measured in assay platform", - "maxLength": 255, - "minLength": 0 - }, - "detectionTechnology": { - "type": "string", - "description": "Specific description of assay platform used", - "maxLength": 255, - "minLength": 0 - }, - "keyAssayReagentType": { - "type": "string", - "description": "Type of critical reactant being measured", - "maxLength": 255, - "minLength": 0 - }, - "keyAssayReagent": { - "type": "string", - "description": "Critical reactant measured", - "maxLength": 255, - "minLength": 0 - }, - "technologicalTargetType": { - "type": "string", - "description": "General description of technological target measured in assay platform", - "maxLength": 255, - "minLength": 0 - }, - "technologicalTargetTypeSub": { - "type": "string", - "description": "Specific description of technological target measured in assay platform", - "maxLength": 255, - "minLength": 0 - }, - "aid": { - "type": "integer", - "format": "int32", - "description": "Assay ID" - }, - "assayName": { - "type": "string", - "description": "Assay name (abbreviated 'anm' within the package)", - "maxLength": 255, - "minLength": 0 - }, - "assayDesc": { - "type": "string", - "description": "Assay description" - }, - "timepointHr": { - "type": "number", - "format": "double", - "description": "Treatment duration in hours" - }, - "organismId": { - "type": "integer", - "format": "int32", - "description": "NCBI taxonomic identifier, available here https://www.ncbi.nlm.nih.gov/taxonomy" - }, - "organism": { - "type": "string", - "description": "Organism of origin", - "maxLength": 255, - "minLength": 0 - }, - "ncbiTaxonId": { - "type": "integer", - "format": "int32" - }, - "taxonName": { - "type": "string", - "maxLength": 255, - "minLength": 0 - }, - "commonName": { - "type": "string", - "maxLength": 255, - "minLength": 0 - }, - "lineage": { - "type": "string", - "maxLength": 255, - "minLength": 0 - }, - "tissue": { - "type": "string", - "description": "Tissue of origin", - "maxLength": 255, - "minLength": 0 - }, - "cellFormat": { - "type": "string", - "description": "Description of cell format", - "maxLength": 255, - "minLength": 0 - }, - "cellFreeComponentSource": { - "type": "string", - "description": "Description of source for targeted cell-free components", - "maxLength": 255, - "minLength": 0 - }, - "cellShortName": { - "type": "string", - "description": "Abbreviation of cell line", - "maxLength": 255, - "minLength": 0 - }, - "cellGrowthMode": { - "type": "string", - "description": "Cell growth modality", - "maxLength": 255, - "minLength": 0 - }, - "assayFootprint": { - "type": "string", - "description": "Microtiter plate size", - "maxLength": 255, - "minLength": 0 - }, - "assayFormatType": { - "type": "string", - "description": "General description of assay format", - "maxLength": 255, - "minLength": 0 - }, - "assayFormatTypeSub": { - "type": "string", - "description": "Specific description of assay format", - "maxLength": 255, - "minLength": 0 - }, - "contentReadoutType": { - "type": "string", - "description": "Description of well characteristics being measured", - "maxLength": 255, - "minLength": 0 - }, - "dilutionSolvent": { - "type": "string", - "description": "Solvent used in sample dilution", - "maxLength": 255, - "minLength": 0 - }, - "dilutionSolventPercentMax": { - "type": "number", - "format": "double", - "description": "Maximum percent of dilution solvent used, from 0 to 1." - }, - "asid": { - "type": "integer", - "format": "int32", - "description": "Assay source ID" - }, - "assaySourceName": { - "type": "string", - "description": "Assay source name (typically an abbreviation of the assay_source_long_name, abbreviated 'asnm' within the package)", - "maxLength": 255, - "minLength": 0 - }, - "assaySourceLongName": { - "type": "string", - "description": "Full assay source name", - "maxLength": 255, - "minLength": 0 - }, - "assaySourceDesc": { - "type": "string", - "description": "Assay source description", - "maxLength": 255, - "minLength": 0 - }, - "gene": { - "type": "array", - "description": "JSON object containing gene mappings", - "items": { - "$ref": "#/components/schemas/Gene" - } - }, - "assayList": { - "type": "array", - "description": "JSON object containing curated groupings of endpoints anchored by use in CCTE publications and/or projects", - "items": { - "$ref": "#/components/schemas/AssayList" - } - }, - "citations": { - "type": "array", - "description": "JSON object containing references to assay-specific publications describing assay design or results", - "items": { - "$ref": "#/components/schemas/Citation" - } - }, - "mc2Methods": { - "type": "array", - "description": "JSON object containing Level 2 Multi-concentration (MC2)", - "items": { - "$ref": "#/components/schemas/Mc2Method" - } - }, - "mc3Methods": { - "type": "array", - "description": "JSON object containing Level 3 Multi-concentration (MC3) normalized concentration-response data", - "items": { - "$ref": "#/components/schemas/Mc3Method" - } - }, - "mc4Methods": { - "type": "array", - "description": "JSON object containing Level 4 Multi-concentration (MC4) All Models Fitting Parameters", - "items": { - "$ref": "#/components/schemas/Mc4Method" - } - }, - "mc5Methods": { - "type": "array", - "description": "JSON object containing Level 5 Multi-concentration (MC5) Winning Model Fitting Parameters", - "items": { - "$ref": "#/components/schemas/Mc5Method" - } - }, - "mc6Methods": { - "type": "array", - "description": "JSON object containing Level 6 Multi-concentration (MC6) Flags", - "items": { - "$ref": "#/components/schemas/Mc6Method" - } - }, - "sc1Methods": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Sc1Method" - } - }, - "sc2Methods": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Sc2Method" - } - } - } - }, - "Mc2Method": { - "type": "object", - "properties": { - "desc": { - "type": "string" - }, - "mc2_mthd": { - "type": "string" - }, - "exec_ordr": { - "type": "integer", - "format": "int32" - }, - "mc2_mthd_id": { - "type": "integer", - "format": "int32" - } - } - }, - "Mc3Method": { - "type": "object", - "properties": { - "desc": { - "type": "string" - }, - "mc3_mthd": { - "type": "string" - }, - "mc3_mthd_id": { - "type": "integer", - "format": "int32" - } - } - }, - "Mc4Method": { - "type": "object", - "properties": { - "desc": { - "type": "string" - }, - "mc4_mthd": { - "type": "string" - }, - "mc4_mthd_id": { - "type": "integer", - "format": "int32" - } - } - }, - "Mc5Method": { - "type": "object", - "properties": { - "desc": { - "type": "string" - }, - "mc5_mthd": { - "type": "string" - }, - "mc5_mthd_id": { - "type": "integer", - "format": "int32" - } - } - }, - "Mc6Method": { - "type": "object", - "properties": { - "desc": { - "type": "string" - }, - "mc6_mthd": { - "type": "string" - }, - "mc6_mthd_id": { - "type": "integer", - "format": "int32" - } - } - }, - "Sc1Method": { - "type": "object", - "properties": { - "desc": { - "type": "string" - }, - "sc1_mthd": { - "type": "string" - }, - "sc1_mthd_id": { - "type": "integer", - "format": "int32" - } - } - }, - "Sc2Method": { - "type": "object", - "properties": { - "desc": { - "type": "string" - }, - "sc2_mthd": { - "type": "string" - }, - "sc2_mthd_id": { - "type": "integer", - "format": "int32" - } - } - }, - "CcDAssayAnnotation": { - "type": "object", - "properties": { - "assayDescs": { - "writeOnly": true - }, - "assayname": { - "writeOnly": true - }, - "tissue": { - "type": "string" - }, - "assayComponentName": { - "type": "string" - }, - "assayFormatTypeSub": { - "type": "string" - }, - "keyPositiveControl": { - "type": "string" - }, - "assayFunctionType": { - "type": "string" - }, - "assayComponentDesc": { - "type": "string" - }, - "cellFreeComponentSource": { - "type": "string" - }, - "intendedTargetTypeSub": { - "type": "string" - }, - "intendedTargetFamily": { - "type": "string" - }, - "parameterReadoutType": { - "type": "string" - }, - "contentReadoutType": { - "type": "string" - }, - "technologicalTargetType": { - "type": "string" - }, - "intendedTargetFamilySub": { - "type": "string" - }, - "biologicalProcessTarget": { - "type": "string" - }, - "detectionTechnology": { - "type": "string" - }, - "assayDesignTypeSub": { - "type": "string" - }, - "intendedTargetType": { - "type": "string" - }, - "detectionTechnologyType": { - "type": "string" - }, - "keyAssayReagentType": { - "type": "string" - }, - "normalizedDataType": { - "type": "string" - }, - "assaySourceLongName": { - "type": "string" - }, - "aeid": { - "type": "integer", - "format": "int64" - }, - "assayComponentEndpointDesc": { - "type": "string" - }, - "assayComponentEndpointName": { - "type": "string" - }, - "organism": { - "type": "string" - }, - "burstAssay": { - "type": "integer", - "format": "int32" - }, - "signalDirection": { - "type": "string" - }, - "assayDesignType": { - "type": "string" - }, - "keyAssayReagent": { - "type": "string" - }, - "timepointHr": { - "type": "number", - "format": "double" - }, - "assayDesc": { - "type": "string" - }, - "cellGrowthMode": { - "type": "string" - }, - "assayFootprint": { - "type": "string" - }, - "dilutionSolvent": { - "type": "string" - }, - "cellFormat": { - "type": "string" - }, - "assaySourceName": { - "type": "string" - }, - "assaySourceDesc": { - "type": "string" - }, - "assayFormatType": { - "type": "string" - }, - "cellShortName": { - "type": "string" - }, - "assayName": { - "type": "string" - }, - "assayComponentTargetDesc": { - "type": "string" - }, - "detectionTechnologyTypeSub": { - "type": "string" - }, - "technologicalTargetTypeSub": { - "type": "string" - }, - "dilutionSolventPercentMax": { - "type": "number", - "format": "double" - }, - "toxCastAssayDescription": { - "type": "string" - }, - "technologicalTargetTypes": { - "writeOnly": true - } - } - }, - "CcdAssayGene": { - "type": "object", - "properties": { - "entrezGeneId": { - "type": "integer", - "format": "int32" - }, - "geneSymbol": { - "type": "string" - }, - "geneName": { - "type": "string" - }, - "serviceEntrezGeneId": { - "writeOnly": true - } - } - }, - "CcdAssayCitation": { - "type": "object", - "properties": { - "url": { - "type": "string" - }, - "aeid": { - "type": "integer", - "format": "int64" - }, - "assayComponentEndpointName": { - "type": "string" - }, - "title": { - "type": "string" - }, - "citation": { - "type": "string" - }, - "otherSource": { - "type": "string" - }, - "author": { - "type": "string" - }, - "otherId": { - "type": "string" - }, - "doi": { - "type": "string" - }, - "pmid": { - "type": "string" - } - } - }, - "CcdTcplData": { - "type": "object", - "properties": { - "methodName": { - "type": "string" - }, - "description": { - "type": "string" - }, - "assayRunType": { - "type": "string" - }, - "levelApplied": { - "type": "integer", - "format": "int32" - }, - "orderId": { - "type": "integer", - "format": "int32" - } - } - }, - "CcdReagents": { - "type": "object", - "properties": { - "cultureOrAssay": { - "type": "string" - }, - "reagentType": { - "type": "string" - }, - "reagentValue": { - "type": "string" - }, - "orderId": { - "type": "integer", - "format": "int32" - } - } - }, - "AOP": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int32" - }, - "toxcastAeid": { - "type": "integer", - "format": "int32" - }, - "entrezGeneId": { - "type": "integer", - "format": "int32" - }, - "eventNumber": { - "type": "integer", - "format": "int32" - }, - "eventLink": { - "type": "string" - }, - "aopNumber": { - "type": "integer", - "format": "int32" - }, - "aopLink": { - "type": "string" - } - } - }, - "AnalyticalQC": { - "type": "object", - "properties": { - "analyticalQcId": { - "type": "integer", - "format": "int64" - }, - "dtxsid": { - "type": "string" - }, - "chnm": { - "type": "string" - }, - "spid": { - "type": "string" - }, - "qcLevel": { - "type": "string" - }, - "t0": { - "type": "string" - }, - "t4": { - "type": "string" - }, - "call": { - "type": "string" - }, - "annotation": { - "type": "string" - }, - "flags": { - "type": "string" - }, - "averageMass": { - "type": "string" - }, - "log10VaporPressureOperaPred": { - "type": "string" - }, - "logkowOctanolWaterOperaPred": { - "type": "string" - }, - "exportDate": { - "type": "string", - "format": "date" - }, - "dataVersion": { - "type": "string" - }, - "porCaution": { - "type": "string" - } - } - }, - "Link": { - "type": "object", - "properties": { - "href": { - "type": "string" - }, - "hreflang": { - "type": "string" - }, - "title": { - "type": "string" - }, - "type": { - "type": "string" - }, - "deprecation": { - "type": "string" - }, - "profile": { - "type": "string" - }, - "name": { - "type": "string" - }, - "templated": { - "type": "boolean" - } - } - }, - "Links": { - "type": "object", - "additionalProperties": { - "$ref": "#/components/schemas/Link" - } + } + } + }, + "components": { + "schemas": { + "BioactivityDataAll": { + "type": "object", + "properties": { + "chnm": { + "type": "string" + }, + "dtxsid": { + "type": "string" + }, + "spid": { + "type": "string" + }, + "m4id": { + "type": "integer", + "format": "int64" + }, + "npts": { + "type": "integer", + "format": "int32" + }, + "coff": { + "type": "number", + "format": "double" + }, + "nconc": { + "type": "integer", + "format": "int32" + }, + "maxMed": { + "type": "number", + "format": "double" + }, + "nmedGtblPos": { + "type": "integer", + "format": "int32" + }, + "modelType": { + "type": "integer", + "format": "int32" + }, + "stkc": { + "type": "number", + "format": "double" + }, + "mc5Param": { + "type": "object", + "additionalProperties": { + "type": "number" + } + }, + "bmad": { + "type": "number", + "format": "double" + }, + "testedConcUnit": { + "type": "string" + }, + "mc6Param": { + "$ref": "#/components/schemas/Mc6Param" + }, + "respMin": { + "type": "number", + "format": "double" + }, + "fitc": { + "type": "integer", + "format": "int32" + }, + "respMax": { + "type": "number", + "format": "double" + }, + "maxMean": { + "type": "number", + "format": "double" + }, + "actp": { + "type": "number", + "format": "double" + }, + "casn": { + "type": "string" + }, + "modl": { + "type": "string" + }, + "maxMedConc": { + "type": "number", + "format": "double" + }, + "m5id": { + "type": "integer", + "format": "int64" + }, + "maxMeanConc": { + "type": "number", + "format": "double" + }, + "chidRep": { + "type": "integer", + "format": "int32" + }, + "concMin": { + "type": "number", + "format": "double" + }, + "nmedGtblNeg": { + "type": "integer", + "format": "int32" + }, + "nrep": { + "type": "number", + "format": "double" + }, + "hitc": { + "type": "number", + "format": "double" + }, + "stkcUnit": { + "type": "string" + }, + "mc3Param": { + "$ref": "#/components/schemas/Mc3Param" + }, + "mc4Param": { + "type": "object", + "additionalProperties": { + "type": "number" + } + }, + "chid": { + "type": "integer", + "format": "int32" + }, + "concMax": { + "type": "number", + "format": "double" + }, + "aeid": { + "type": "integer", + "format": "int64" + } + } + }, + "Mc3Param": { + "type": "object", + "properties": { + "conc": { + "type": "array", + "items": { + "type": "number" + } + }, + "resp": { + "type": "array", + "items": { + "type": "number" + } + } + } + }, + "Mc6Param": { + "type": "object", + "properties": { + "flag": { + "type": "array", + "items": { + "type": "string" + } + }, + "mc6MthdId": { + "type": "array", + "items": { + "type": "integer", + "format": "int32" + } + } + } + }, + "AedData": { + "type": "object", + "properties": { + "dtxsid": { + "type": "string" + }, + "preferredName": { + "type": "string" + }, + "aeid": { + "type": "integer", + "format": "int32" + }, + "aenm": { + "type": "string" + }, + "aedVal": { + "type": "array", + "items": { + "type": "number", + "format": "double" + } + }, + "aedType": { + "type": "array", + "items": { + "type": "string" + } + }, + "httkModel": { + "type": "array", + "items": { + "type": "string" + } + }, + "aedValUnit": { + "type": "array", + "items": { + "type": "string" } + }, + "httkVersion": { + "type": "array", + "items": { + "type": "string" + } + }, + "potencyValType": { + "type": "array", + "items": { + "type": "string" + } + }, + "invitrodbVersion": { + "type": "array", + "items": { + "type": "string" + } + }, + "interindividualVarPerc": { + "type": "array", + "items": { + "type": "number", + "format": "double" + } + } + } + }, + "AssayAll": { + "type": "object", + "properties": { + "assayComponentName": { + "type": "string" + }, + "assayComponentEndpointDesc": { + "type": "string" + }, + "assayComponentEndpointName": { + "type": "string" + }, + "acid": { + "type": "integer", + "format": "int32" + }, + "signalDirection": { + "type": "string" + }, + "burstAssay": { + "type": "integer", + "format": "int32" + }, + "cellShortName": { + "type": "string" + }, + "organismId": { + "type": "integer", + "format": "int32" + }, + "assaySourceName": { + "type": "string" + }, + "aid": { + "type": "integer", + "format": "int32" + }, + "assayFootprint": { + "type": "string" + }, + "cellFormat": { + "type": "string" + }, + "organism": { + "type": "string" + }, + "assaySourceDesc": { + "type": "string" + }, + "cellGrowthMode": { + "type": "string" + }, + "assayDesc": { + "type": "string" + }, + "asid": { + "type": "integer", + "format": "int32" + }, + "timepointHr": { + "type": "number", + "format": "double" + }, + "assayDesignType": { + "type": "string" + }, + "keyAssayReagent": { + "type": "string" + }, + "gene": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Gene" + } + }, + "citations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Citation" + } + }, + "assayFormatType": { + "type": "string" + }, + "tissue": { + "type": "string" + }, + "dilutionSolvent": { + "type": "string" + }, + "assayList": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AssayList" + } + }, + "aeid": { + "type": "integer", + "format": "int64" + }, + "assayComponentDesc": { + "type": "string" + }, + "cellViabilityAssay": { + "type": "integer", + "format": "int32" + }, + "intendedTargetFamilySub": { + "type": "string" + }, + "normalizedDataType": { + "type": "string" + }, + "keyPositiveControl": { + "type": "string" + }, + "assayComponentTargetDesc": { + "type": "string" + }, + "assayFunctionType": { + "type": "string" + }, + "intendedTargetType": { + "type": "string" + }, + "intendedTargetTypeSub": { + "type": "string" + }, + "intendedTargetFamily": { + "type": "string" + }, + "contentReadoutType": { + "type": "string" + }, + "detectionTechnologyTypeSub": { + "type": "string" + }, + "biologicalProcessTarget": { + "type": "string" + }, + "dilutionSolventPercentMax": { + "type": "number", + "format": "double" + }, + "assayFormatTypeSub": { + "type": "string" + }, + "keyAssayReagentType": { + "type": "string" + }, + "cellFreeComponentSource": { + "type": "string" + }, + "technologicalTargetTypeSub": { + "type": "string" + }, + "detectionTechnology": { + "type": "string" + }, + "detectionTechnologyType": { + "type": "string" + }, + "technologicalTargetType": { + "type": "string" + }, + "assaySourceLongName": { + "type": "string" + }, + "assayDesignTypeSub": { + "type": "string" + }, + "parameterReadoutType": { + "type": "string" + }, + "assayName": { + "type": "string" + }, + "technologicalTargetTypes": { + "writeOnly": true + }, + "assayDescs": { + "writeOnly": true + }, + "assayname": { + "writeOnly": true + } + } + }, + "AssayList": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "description": { + "type": "string" + } + } + }, + "Citation": { + "type": "object", + "properties": { + "doi": { + "type": "string" + }, + "url": { + "type": "string" + }, + "pmid": { + "type": "integer", + "format": "int32" + }, + "title": { + "type": "string" + }, + "author": { + "type": "string" + }, + "citation": { + "type": "string" + }, + "otherId": { + "type": "string" + }, + "citationId": { + "type": "integer", + "format": "int32" + }, + "otherSource": { + "type": "string" + } + } + }, + "Gene": { + "type": "object", + "properties": { + "geneId": { + "type": "integer", + "format": "int32" + }, + "geneName": { + "type": "string" + }, + "description": { + "type": "string" + }, + "geneSymbol": { + "type": "string", + "deprecated": true + }, + "organismId": { + "type": "integer", + "format": "int32" + }, + "trackStatus": { + "type": "string" + }, + "entrezGeneId": { + "type": "integer", + "format": "int32" + }, + "officialSymbol": { + "type": "string" + }, + "officialFullName": { + "type": "string" + }, + "uniprotAccessionNumber": { + "type": "string" + } + } + }, + "SearchAssay": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int32" + }, + "aeid": { + "type": "integer", + "format": "int32" + }, + "searchName": { + "type": "string", + "maxLength": 50, + "minLength": 0 + }, + "searchValue": { + "type": "string", + "maxLength": 200, + "minLength": 0 + }, + "searchValueDesc": { + "type": "string" + }, + "modifiedValue": { + "type": "string" + } }, - "securitySchemes": { - "api_key": { - "type": "apiKey", - "description": "Each API request requires an api_key. Contact the CTX API Admin to request an API Key.", - "name": "x-api-key", - "in": "header" + "required": [ + "aeid", + "id" + ] + }, + "ProblemDetail": { + "type": "object", + "properties": { + "type": { + "type": "string", + "format": "uri" + }, + "title": { + "type": "string" + }, + "status": { + "type": "integer", + "format": "int32" + }, + "detail": { + "type": "string" + }, + "instance": { + "type": "string", + "format": "uri" + }, + "properties": { + "type": "object", + "additionalProperties": { + + } + } + } + }, + "BioactivityModel": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int32" + }, + "dtxsid": { + "type": "string" + }, + "model": { + "type": "string" + }, + "receptor": { + "type": "string" + }, + "agonist": { + "type": "string" + }, + "antagonist": { + "type": "string" + }, + "binding": { + "type": "string" + }, + "modelDesc": { + "type": "string" + } + } + }, + "SummaryByTissue": { + "type": "object", + "properties": { + "dtxsid": { + "type": "string" + }, + "tissue": { + "type": "string" + }, + "maxMedConc": { + "type": "number", + "format": "float" + }, + "intendedTargetFamily": { + "type": "string" + }, + "continuousHitCall": { + "type": "number", + "format": "float" + }, + "hitCall": { + "type": "string" + }, + "ac50": { + "type": "number", + "format": "float" + }, + "cutOff": { + "type": "number", + "format": "float" + }, + "acc": { + "type": "number", + "format": "float" + }, + "logAC50": { + "type": "number", + "format": "float" + }, + "chemicalName": { + "type": "string" + } + } + }, + "ChemicalAgg": { + "type": "object", + "properties": { + "dtxsid": { + "type": "string", + "maxLength": 255, + "minLength": 0 + }, + "activeMc": { + "type": "integer", + "format": "int32" + }, + "totalMc": { + "type": "integer", + "format": "int32" + }, + "activeSc": { + "type": "integer", + "format": "int32" + }, + "totalSc": { + "type": "integer", + "format": "int32" + }, + "cytotoxMedianRaw": { + "type": "number", + "format": "float" + }, + "cytotoxMad": { + "type": "number", + "format": "float" + }, + "globalMad": { + "type": "number", + "format": "float" + }, + "cytotoxMedianLog": { + "type": "number", + "format": "float" + }, + "cytotoxMedianUm": { + "type": "number", + "format": "float" + }, + "cytotoxLowerUm": { + "type": "number", + "format": "float" + }, + "cytotoxLowerLog": { + "type": "number", + "format": "float" + }, + "ntested": { + "type": "number", + "format": "float" + }, + "nhit": { + "type": "number", + "format": "float" + } + } + }, + "AssayAgg": { + "type": "object", + "properties": { + "aeid": { + "type": "integer", + "format": "int64", + "description": "Assay component endpoint ID" + }, + "activeMc": { + "type": "integer", + "format": "int32", + "maximum": 23, + "minimum": 0 + }, + "totalMc": { + "type": "integer", + "format": "int64" + }, + "activeSc": { + "type": "integer", + "format": "int32", + "maximum": 23, + "minimum": 0 + }, + "totalSc": { + "type": "integer", + "format": "int64" + } + } + }, + "CcdSingleConcData": { + "type": "object", + "properties": { + "dtxsid": { + "type": "string" + }, + "coff": { + "type": "number", + "format": "double" + }, + "bmad": { + "type": "number", + "format": "double" + }, + "casn": { + "type": "string" + }, + "hitc": { + "type": "number", + "format": "double" + }, + "s2id": { + "type": "integer", + "format": "int64" + }, + "preferredName": { + "type": "string" + }, + "aeid": { + "type": "integer", + "format": "int32" + }, + "endpointName": { + "type": "string" + }, + "maxMedVal": { + "type": "number", + "format": "double" + } + } + }, + "AssayEndpointsList": { + "type": "object", + "properties": { + "geneSymbol": { + "type": "string", + "deprecated": true + }, + "officialSymbol": { + "type": "string" + }, + "assayComponentEndpointDesc": { + "type": "string" + }, + "assayComponentEndpointName": { + "type": "string" + }, + "aeid": { + "type": "integer", + "format": "int64" + }, + "singleConcActive": { + "type": "string" + }, + "multiConcActives": { + "type": "string" + } + } + }, + "AssayAnnotation": { + "type": "object", + "description": "US EPA's Toxicity Forecaster (ToxCast) program makes invitro medium- and high-throughput screening assay data publicly available for prioritization and hazard characterization. Given ToxCast includes a heterogeneous set of assays across a diverse biological space, annotations in the database help flexibly aggregate and differentiate processed data. The definition of an “assay” is, in ToxCast, broken into 4 assay elements: assay source: the vendor/origination of the data, assay: the procedure to generate the component data, assay component: the raw data readout(s), assay component endpoint: the normalized component data. The assay element annotations are often short in a standardized format or use a controlled term list. Assay” resource endpoints provide assay metadata for specific or all invitrodb ‘aeids’ (assay endpoint ids). These include annotations from invitrodb’s assay, assay_component, assay_component_endpoint, assay_list, assay_source, and gene tables, all returned in a by-aeid format. Regular ToxCast/invitrodb users may find it easier to use the tcpl R package, which has integrated to make API data retrievable in a familiar format. See the tcpl vignette regarding data retrieval via API for more information.", + "properties": { + "aeid": { + "type": "integer", + "format": "int64", + "description": "Assay component endpoint ID" + }, + "assayComponentEndpointName": { + "type": "string", + "description": "Assay component endpoint name (abbreviated 'aenm' within the package)", + "maxLength": 255, + "minLength": 0 + }, + "assayComponentEndpointDesc": { + "type": "string", + "description": "Assay component endpoint description" + }, + "assayFunctionType": { + "type": "string", + "description": "Description of targeted mechanism and the purpose of the analyzed readout in relation to others from the same assay", + "maxLength": 255, + "minLength": 0 + }, + "normalizedDataType": { + "type": "string", + "description": "Normalization approach for which the data is displayed", + "maxLength": 255, + "minLength": 0 + }, + "burstAssay": { + "type": "integer", + "format": "int32", + "description": "Indicator if endpoint is included in the burst distribution (1) or not (0); Burst phenomenon can describe confounding activity, such as cytotoxicity due to non-specific activation of many targets at certain concentrations" + }, + "keyPositiveControl": { + "type": "string", + "description": "Tested chemical sample expected to produce activity; Used to assess assay validity", + "maxLength": 255, + "minLength": 0 + }, + "signalDirection": { + "type": "string", + "description": "Directionality of raw data signals from assay (gain or loss); Defines analysis direction", + "maxLength": 255, + "minLength": 0 + }, + "intendedTargetType": { + "type": "string", + "description": "General group of intended targets measured", + "maxLength": 255, + "minLength": 0 + }, + "intendedTargetTypeSub": { + "type": "string", + "description": "Specific subgroup of intended targets measured", + "maxLength": 255, + "minLength": 0 + }, + "intendedTargetFamily": { + "type": "string", + "description": "Family of intended target measured; Populated on ToxCast chemical activity plot within CompTox dashboard", + "maxLength": 255, + "minLength": 0 + }, + "intendedTargetFamilySub": { + "type": "string", + "description": "Specific subfamily of intended target measured", + "maxLength": 255, + "minLength": 0 + }, + "cellViabilityAssay": { + "type": "integer", + "format": "int32", + "description": "Indicator of the impact of cytotoxicity in confounding (1) or no cytotoxic impact (0)" + }, + "acid": { + "type": "integer", + "format": "int32", + "description": "Assay component ID" + }, + "assayComponentName": { + "type": "string", + "description": "Assay component name (abbreviated 'acnm' within the package)", + "maxLength": 255, + "minLength": 0 + }, + "assayComponentDesc": { + "type": "string", + "description": "Assay component description" + }, + "assayComponentTargetDesc": { + "type": "string", + "description": "Assay component target description. Generally includes information about mechanism of action with assay target, how disruption is detected, or significance of target disruption." + }, + "parameterReadoutType": { + "type": "string", + "description": "Description of parameters measured", + "maxLength": 255, + "minLength": 0 + }, + "assayDesignType": { + "type": "string", + "description": "General description of the biological or physical process is translated into a detectable signal by assay mechanism", + "maxLength": 255, + "minLength": 0 + }, + "assayDesignTypeSub": { + "type": "string", + "description": "Specific description of method through which a biological or physical process is translated into a detectable signal measured", + "maxLength": 255, + "minLength": 0 + }, + "biologicalProcessTarget": { + "type": "string", + "description": "General biological process being chemically disrupted", + "maxLength": 255, + "minLength": 0 + }, + "detectionTechnologyType": { + "type": "string", + "description": "General description of assay platform or detection signals measured", + "maxLength": 255, + "minLength": 0 + }, + "detectionTechnologyTypeSub": { + "type": "string", + "description": "Description of signals measured in assay platform", + "maxLength": 255, + "minLength": 0 + }, + "detectionTechnology": { + "type": "string", + "description": "Specific description of assay platform used", + "maxLength": 255, + "minLength": 0 + }, + "keyAssayReagentType": { + "type": "string", + "description": "Type of critical reactant being measured", + "maxLength": 255, + "minLength": 0 + }, + "keyAssayReagent": { + "type": "string", + "description": "Critical reactant measured", + "maxLength": 255, + "minLength": 0 + }, + "technologicalTargetType": { + "type": "string", + "description": "General description of technological target measured in assay platform", + "maxLength": 255, + "minLength": 0 + }, + "technologicalTargetTypeSub": { + "type": "string", + "description": "Specific description of technological target measured in assay platform", + "maxLength": 255, + "minLength": 0 + }, + "aid": { + "type": "integer", + "format": "int32", + "description": "Assay ID" + }, + "assayName": { + "type": "string", + "description": "Assay name (abbreviated 'anm' within the package)", + "maxLength": 255, + "minLength": 0 + }, + "assayDesc": { + "type": "string", + "description": "Assay description" + }, + "timepointHr": { + "type": "number", + "format": "double", + "description": "Treatment duration in hours" + }, + "organismId": { + "type": "integer", + "format": "int32", + "description": "NCBI taxonomic identifier, available here https://www.ncbi.nlm.nih.gov/taxonomy" + }, + "organism": { + "type": "string", + "description": "Organism of origin", + "maxLength": 255, + "minLength": 0 + }, + "ncbiTaxonId": { + "type": "integer", + "format": "int32" + }, + "taxonName": { + "type": "string", + "maxLength": 255, + "minLength": 0 + }, + "commonName": { + "type": "string", + "maxLength": 255, + "minLength": 0 + }, + "lineage": { + "type": "string", + "maxLength": 255, + "minLength": 0 + }, + "tissue": { + "type": "string", + "description": "Tissue of origin", + "maxLength": 255, + "minLength": 0 + }, + "cellFormat": { + "type": "string", + "description": "Description of cell format", + "maxLength": 255, + "minLength": 0 + }, + "cellFreeComponentSource": { + "type": "string", + "description": "Description of source for targeted cell-free components", + "maxLength": 255, + "minLength": 0 + }, + "cellShortName": { + "type": "string", + "description": "Abbreviation of cell line", + "maxLength": 255, + "minLength": 0 + }, + "cellGrowthMode": { + "type": "string", + "description": "Cell growth modality", + "maxLength": 255, + "minLength": 0 + }, + "assayFootprint": { + "type": "string", + "description": "Microtiter plate size", + "maxLength": 255, + "minLength": 0 + }, + "assayFormatType": { + "type": "string", + "description": "General description of assay format", + "maxLength": 255, + "minLength": 0 + }, + "assayFormatTypeSub": { + "type": "string", + "description": "Specific description of assay format", + "maxLength": 255, + "minLength": 0 + }, + "contentReadoutType": { + "type": "string", + "description": "Description of well characteristics being measured", + "maxLength": 255, + "minLength": 0 + }, + "dilutionSolvent": { + "type": "string", + "description": "Solvent used in sample dilution", + "maxLength": 255, + "minLength": 0 + }, + "dilutionSolventPercentMax": { + "type": "number", + "format": "double", + "description": "Maximum percent of dilution solvent used, from 0 to 1." + }, + "asid": { + "type": "integer", + "format": "int32", + "description": "Assay source ID" + }, + "assaySourceName": { + "type": "string", + "description": "Assay source name (typically an abbreviation of the assay_source_long_name, abbreviated 'asnm' within the package)", + "maxLength": 255, + "minLength": 0 + }, + "assaySourceLongName": { + "type": "string", + "description": "Full assay source name", + "maxLength": 255, + "minLength": 0 + }, + "assaySourceDesc": { + "type": "string", + "description": "Assay source description", + "maxLength": 255, + "minLength": 0 + }, + "gene": { + "type": "array", + "description": "JSON object containing gene mappings", + "items": { + "$ref": "#/components/schemas/Gene" + } + }, + "assayList": { + "type": "array", + "description": "JSON object containing curated groupings of endpoints anchored by use in CCTE publications and/or projects", + "items": { + "$ref": "#/components/schemas/AssayList" + } + }, + "citations": { + "type": "array", + "description": "JSON object containing references to assay-specific publications describing assay design or results", + "items": { + "$ref": "#/components/schemas/Citation" + } + }, + "mc2Methods": { + "type": "array", + "description": "JSON object containing Level 2 Multi-concentration (MC2)", + "items": { + "$ref": "#/components/schemas/Mc2Method" } + }, + "mc3Methods": { + "type": "array", + "description": "JSON object containing Level 3 Multi-concentration (MC3) normalized concentration-response data", + "items": { + "$ref": "#/components/schemas/Mc3Method" + } + }, + "mc4Methods": { + "type": "array", + "description": "JSON object containing Level 4 Multi-concentration (MC4) All Models Fitting Parameters", + "items": { + "$ref": "#/components/schemas/Mc4Method" + } + }, + "mc5Methods": { + "type": "array", + "description": "JSON object containing Level 5 Multi-concentration (MC5) Winning Model Fitting Parameters", + "items": { + "$ref": "#/components/schemas/Mc5Method" + } + }, + "mc6Methods": { + "type": "array", + "description": "JSON object containing Level 6 Multi-concentration (MC6) Flags", + "items": { + "$ref": "#/components/schemas/Mc6Method" + } + }, + "sc1Methods": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Sc1Method" + } + }, + "sc2Methods": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Sc2Method" + } + } + } + }, + "Mc2Method": { + "type": "object", + "properties": { + "desc": { + "type": "string" + }, + "mc2_mthd": { + "type": "string" + }, + "exec_ordr": { + "type": "integer", + "format": "int32" + }, + "mc2_mthd_id": { + "type": "integer", + "format": "int32" + } + } + }, + "Mc3Method": { + "type": "object", + "properties": { + "desc": { + "type": "string" + }, + "mc3_mthd": { + "type": "string" + }, + "mc3_mthd_id": { + "type": "integer", + "format": "int32" + } } + }, + "Mc4Method": { + "type": "object", + "properties": { + "desc": { + "type": "string" + }, + "mc4_mthd": { + "type": "string" + }, + "mc4_mthd_id": { + "type": "integer", + "format": "int32" + } + } + }, + "Mc5Method": { + "type": "object", + "properties": { + "desc": { + "type": "string" + }, + "mc5_mthd": { + "type": "string" + }, + "mc5_mthd_id": { + "type": "integer", + "format": "int32" + } + } + }, + "Mc6Method": { + "type": "object", + "properties": { + "desc": { + "type": "string" + }, + "mc6_mthd": { + "type": "string" + }, + "mc6_mthd_id": { + "type": "integer", + "format": "int32" + } + } + }, + "Sc1Method": { + "type": "object", + "properties": { + "desc": { + "type": "string" + }, + "sc1_mthd": { + "type": "string" + }, + "sc1_mthd_id": { + "type": "integer", + "format": "int32" + } + } + }, + "Sc2Method": { + "type": "object", + "properties": { + "desc": { + "type": "string" + }, + "sc2_mthd": { + "type": "string" + }, + "sc2_mthd_id": { + "type": "integer", + "format": "int32" + } + } + }, + "CcDAssayAnnotation": { + "type": "object", + "properties": { + "assayComponentName": { + "type": "string" + }, + "assayComponentEndpointDesc": { + "type": "string" + }, + "assayComponentEndpointName": { + "type": "string" + }, + "signalDirection": { + "type": "string" + }, + "burstAssay": { + "type": "integer", + "format": "int32" + }, + "cellShortName": { + "type": "string" + }, + "assaySourceName": { + "type": "string" + }, + "assayFootprint": { + "type": "string" + }, + "cellFormat": { + "type": "string" + }, + "organism": { + "type": "string" + }, + "assaySourceDesc": { + "type": "string" + }, + "cellGrowthMode": { + "type": "string" + }, + "assayDesc": { + "type": "string" + }, + "timepointHr": { + "type": "number", + "format": "double" + }, + "assayDesignType": { + "type": "string" + }, + "keyAssayReagent": { + "type": "string" + }, + "assayFormatType": { + "type": "string" + }, + "tissue": { + "type": "string" + }, + "dilutionSolvent": { + "type": "string" + }, + "aeid": { + "type": "integer", + "format": "int64" + }, + "assayComponentDesc": { + "type": "string" + }, + "intendedTargetFamilySub": { + "type": "string" + }, + "normalizedDataType": { + "type": "string" + }, + "keyPositiveControl": { + "type": "string" + }, + "assayComponentTargetDesc": { + "type": "string" + }, + "assayFunctionType": { + "type": "string" + }, + "intendedTargetType": { + "type": "string" + }, + "intendedTargetTypeSub": { + "type": "string" + }, + "intendedTargetFamily": { + "type": "string" + }, + "contentReadoutType": { + "type": "string" + }, + "detectionTechnologyTypeSub": { + "type": "string" + }, + "biologicalProcessTarget": { + "type": "string" + }, + "dilutionSolventPercentMax": { + "type": "number", + "format": "double" + }, + "assayFormatTypeSub": { + "type": "string" + }, + "keyAssayReagentType": { + "type": "string" + }, + "cellFreeComponentSource": { + "type": "string" + }, + "technologicalTargetTypeSub": { + "type": "string" + }, + "detectionTechnology": { + "type": "string" + }, + "detectionTechnologyType": { + "type": "string" + }, + "technologicalTargetType": { + "type": "string" + }, + "assaySourceLongName": { + "type": "string" + }, + "assayDesignTypeSub": { + "type": "string" + }, + "parameterReadoutType": { + "type": "string" + }, + "assayName": { + "type": "string" + }, + "toxCastAssayDescription": { + "type": "string" + }, + "technologicalTargetTypes": { + "writeOnly": true + }, + "assayDescs": { + "writeOnly": true + }, + "assayname": { + "writeOnly": true + } + } + }, + "CcdAssayGene": { + "type": "object", + "properties": { + "geneSymbol": { + "type": "string", + "deprecated": true + }, + "geneName": { + "type": "string" + }, + "officialSymbol": { + "type": "string" + }, + "entrezGeneId": { + "type": "integer", + "format": "int32" + }, + "serviceEntrezGeneId": { + "writeOnly": true + } + } + }, + "CcdAssayCitation": { + "type": "object", + "properties": { + "author": { + "type": "string" + }, + "citation": { + "type": "string" + }, + "otherId": { + "type": "string" + }, + "otherSource": { + "type": "string" + }, + "doi": { + "type": "string" + }, + "pmid": { + "type": "string" + }, + "url": { + "type": "string" + }, + "assayComponentEndpointName": { + "type": "string" + }, + "title": { + "type": "string" + }, + "aeid": { + "type": "integer", + "format": "int64" + } + } + }, + "CcdTcplData": { + "type": "object", + "properties": { + "methodName": { + "type": "string" + }, + "description": { + "type": "string" + }, + "orderId": { + "type": "integer", + "format": "int32" + }, + "levelApplied": { + "type": "integer", + "format": "int32" + }, + "assayRunType": { + "type": "string" + } + } + }, + "CcdReagents": { + "type": "object", + "properties": { + "reagentValue": { + "type": "string" + }, + "orderId": { + "type": "integer", + "format": "int32" + }, + "cultureOrAssay": { + "type": "string" + }, + "reagentType": { + "type": "string" + } + } + }, + "AOP": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int32" + }, + "toxcastAeid": { + "type": "integer", + "format": "int32" + }, + "entrezGeneId": { + "type": "integer", + "format": "int32" + }, + "eventNumber": { + "type": "integer", + "format": "int32" + }, + "eventLink": { + "type": "string" + }, + "aopNumber": { + "type": "integer", + "format": "int32" + }, + "aopLink": { + "type": "string" + } + } + }, + "AnalyticalQC": { + "type": "object", + "properties": { + "analyticalQcId": { + "type": "integer", + "format": "int64" + }, + "dtxsid": { + "type": "string" + }, + "chnm": { + "type": "string" + }, + "spid": { + "type": "string" + }, + "qcLevel": { + "type": "string" + }, + "t0": { + "type": "string" + }, + "t4": { + "type": "string" + }, + "call": { + "type": "string" + }, + "annotation": { + "type": "string" + }, + "flags": { + "type": "string" + }, + "averageMass": { + "type": "string" + }, + "log10VaporPressureOperaPred": { + "type": "string" + }, + "logkowOctanolWaterOperaPred": { + "type": "string" + }, + "exportDate": { + "type": "string", + "format": "date" + }, + "dataVersion": { + "type": "string" + }, + "porCaution": { + "type": "string" + } + } + }, + "Link": { + "type": "object", + "properties": { + "href": { + "type": "string" + }, + "hreflang": { + "type": "string" + }, + "title": { + "type": "string" + }, + "type": { + "type": "string" + }, + "deprecation": { + "type": "string" + }, + "profile": { + "type": "string" + }, + "name": { + "type": "string" + }, + "templated": { + "type": "boolean" + } + } + }, + "Links": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/Link" + } + } + }, + "securitySchemes": { + "api_key": { + "type": "apiKey", + "description": "Each API request requires an api_key. Contact the CTX API Admin to request an API Key.", + "name": "x-api-key", + "in": "header" + } } -} + } +} \ No newline at end of file diff --git a/public/docs/chemical.json b/public/docs/chemical.json index 9d5b9e7..5df6abf 100644 --- a/public/docs/chemical.json +++ b/public/docs/chemical.json @@ -1,4297 +1,4869 @@ { - "openapi": "3.1.0", - "info": { - "title": "Computational Toxicology and Exposure (CTX) APIs - CTX Chemical API", - "description": "The CTX Chemical API is part of US EPA's Computational Toxicology and Exposure APIs. The CTX Chemical API provides programmtic access to chemical data through a set of endpoints.", - "version": "1.1.1" + "openapi": "3.1.0", + "info": { + "title": "Computational Toxicology and Exposure (CTX) APIs - CTX Chemical API", + "description": "The CTX Chemical API is part of US EPA's Computational Toxicology and Exposure APIs. The CTX Chemical API provides programmtic access to chemical data through a set of endpoints.", + "version": "1.1.1" + }, + "servers": [ + { + "url": "https://comptox.epa.gov/ctx-api", + "description": "Production Environment" + } + ], + "tags": [ + { + "name": "OPSIN Resource", + "description": "Collection of endpoints to return chemical data by Systematic IUPAC Name from EMBL-EBI's Open Parser for Systematic IUPAC Nomenclature (OPSIN)." }, - "servers": [ - { - "url": "https://ctx-api-dev.ccte.epa.gov", - "description": "Development Environment" - } - ], - "tags": [ - { - "name": "Chemical File Resource", - "description": "Collection of endpoints for chemical structure information in mol and image (png format). This curated data is sourced from the US EPA's Distributed Structure-Searchable Toxicity (DSSTox) database." - }, - { - "name": "Chemical Details Resource", - "description": "Collection of endpoints with chemical details. This curated data is sourced from the US EPA's Distributed Structure-Searchable Toxicity (DSSTox) database." - }, - { - "name": "Chemical List Resource", - "description": "Collection of endpoints for chemical lists. This curated data is sourced from the US EPA's Distributed Structure-Searchable Toxicity (DSSTox) database." - }, - { - "name": "Chemical Property Resource", - "description": "Collection of endpoints for experimental and predictive chemical properties. This curated data is sourced from the US EPA's Distributed Structure-Searchable Toxicity (DSSTox) database and the Toxicity Estimation Software Tool (TEST) suite of QSAR models." + { + "name": "Lit Search Data Resource", + "description": "Collection of endpoints containing extra chemical data pertaining to literature and patents." + }, + { + "name": "Chemical Search Resource", + "description": "Collection of endpoints for searching for chemicals across chemical names and synonyms. Search string options include starts-with, exact, or contains." + }, + { + "name": "Chemical File Resource", + "description": "Collection of endpoints for chemical structure information in mol, mrv and image (png or svg format). This curated data is sourced from the US EPA's Distributed Structure-Searchable Toxicity (DSSTox) database." + }, + { + "name": "Chemical List Resource", + "description": "Collection of endpoints for chemical lists. This curated data is sourced from the US EPA's Distributed Structure-Searchable Toxicity (DSSTox) database." + }, + { + "name": "Chemical Details Resource", + "description": "Collection of endpoints with chemical details. This curated data is sourced from the US EPA's Distributed Structure-Searchable Toxicity (DSSTox) database." + }, + { + "name": "PubChem to GHS Classification Resource", + "description": "Collection of endpoints to check if GHS classification safety data in available in PubChem." + }, + { + "name": "Chemical Property Resource", + "description": "Collection of endpoints for experimental and predictive chemical properties. This curated data is sourced from the US EPA's Distributed Structure-Searchable Toxicity (DSSTox) database and the Toxicity Estimation Software Tool (TEST) suite of QSAR models." + }, + { + "name": "Chemical Synonym Resource", + "description": "Collection of endpoints containing chemical synonyms. This curated data is sourced from the US EPA's Distributed Structure-Searchable Toxicity (DSSTox) database." + }, + { + "name": "Wikipedia to GHS Classification Resource", + "description": "Collection of endpoints to check if GHS classification safety data is available on Wikipedia." + } + ], + "paths": { + "/chemical/wikipedia/by-dtxsid/": { + "post": { + "tags": [ + "Wikipedia to GHS Classification Resource" + ], + "summary": "Check for link for a batch of DTXSIDs", + "description": "This endpoint will return Y if Wikipedia has GHS Safety data, otherwise N.", + "operationId": "byBatchDtxsid", + "requestBody": { + "description": "JSON array of DSSTox Substance Identifiers", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "example": "[\"DTXSID7020182\",\"DTXSID9020112\"]" + } + }, + "required": true }, - { - "name": "Chemical Search Resource", - "description": "Collection of endpoints for searching for chemicals across chemical names and synonyms. Search string options include starts-with, exact, or contains." + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/WikipediaLinkResponse" + } + } + } + } + } }, - { - "name": "Chemical Synonym Resource", - "description": "Collection of endpoints containing chemical synonyms. This curated data is sourced from the US EPA's Distributed Structure-Searchable Toxicity (DSSTox) database." + "security": [ + { + "api_key": [] + } + ] + } + }, + "/chemical/synonym/search/by-dtxsid/": { + "post": { + "tags": [ + "Chemical Synonym Resource" + ], + "summary": "Get synonyms for a batch of DTXSIDs", + "operationId": "synoymsByBatchDtxsid", + "requestBody": { + "description": "JSON array of DSSTox Substance Identifiers", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "example": "[\"DTXSID7020182\",\"DTXSID9020112\"]" + } + }, + "required": true }, - { - "name": "Lit Search Data Resource", - "description": "Collection of endpoints containing extra chemical data pertaining to literature and patents." - } - ], - "paths": { - "/chemical/synonym/search/by-dtxsid/": { - "post": { - "tags": [ - "Chemical Synonym Resource" - ], - "summary": "Get synonyms for a batch of DTXSIDs", - "operationId": "synoymsByBatchDtxsid", - "requestBody": { - "description": "JSON array of DSSTox Substance Identifiers", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "type": "string" - } - }, - "example": "[\"DTXSID7020182\",\"DTXSID9020112\"]" - } - }, - "required": true - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "string", - "oneOf": [ - { - "$ref": "#/components/schemas/ChemicalSynonymAll" - } - ] - } - } - } - } - }, - "security": [ + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "string", + "oneOf": [ { - "api_key": [] + "$ref": "#/components/schemas/ChemicalSynonymAll" } - ] + ] + } + } } + } }, - "/chemical/search/equal/": { - "post": { - "tags": [ - "Chemical Search Resource" - ], - "summary": "Get chemicals for a batch of exact values", - "description": "Values must be separated by EOL characters and a maximum of 200 values is allowed per request.", - "operationId": "chemicalBatchEqual", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "string" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "string", - "oneOf": [ - { - "$ref": "#/components/schemas/ChemicalBatchSearchResult" - } - ] - } - } - } - } - }, - "security": [ - { - "api_key": [] - } - ] + "security": [ + { + "api_key": [] + } + ] + } + }, + "/chemical/search/equal/": { + "post": { + "tags": [ + "Chemical Search Resource" + ], + "summary": "Get chemicals for a batch of exact values", + "description": "Values must be separated by EOL characters and a maximum of 200 values is allowed per request.", + "operationId": "chemicalBatchEqual", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "string" + } } + }, + "required": true }, - "/chemical/search/by-msready-formula/": { - "post": { - "tags": [ - "Chemical Search Resource" - ], - "summary": "Get chemicals for a batch of MS-ready formulas", - "operationId": "getChemicalsForBatchMsreadyFormula", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "type": "string" - } - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - } - }, - "security": [ + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "string", + "oneOf": [ { - "api_key": [] + "$ref": "#/components/schemas/ChemicalBatchSearchResult" } - ] + ] + } + } } + } }, - "/chemical/property/predicted/search/by-dtxsid/": { - "post": { - "tags": [ - "Chemical Property Resource" - ], - "summary": "Get predicted properties for a batch of DTXSIDs", - "description": "Note: Maximum 1000 DTXSIDs per request", - "operationId": "predictedBatchSearch", - "requestBody": { - "description": "JSON array of DSSTox Substance Identifiers", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "type": "string" - } - }, - "example": "[\"DTXSID7020182\",\"DTXSID9020112\"]" - } - }, - "required": true - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "string", - "oneOf": [ - { - "$ref": "#/components/schemas/ChemicalPropertyPredicted" - } - ] - } - } - } - }, - "400": { - "description": "User has submitted more than allowed number (1000) of DTXSID(s).", - "content": { - "application/json": { - "schema": { - "type": "string", - "oneOf": [ - { - "$ref": "#/components/schemas/ProblemDetail" - } - ] - }, - "example": { - "title": "Validation Error", - "status": 400, - "detail": "System supports only '200' dtxsid at one time, '202' are submitted." - } - } - } - } - }, - "security": [ - { - "api_key": [] - } - ] + "security": [ + { + "api_key": [] + } + ] + } + }, + "/chemical/search/by-msready-formula/": { + "post": { + "tags": [ + "Chemical Search Resource" + ], + "summary": "Get chemicals for a batch of MS-ready formulas", + "operationId": "getChemicalsForBatchMsreadyFormula", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "string" + } + } } + }, + "required": true }, - "/chemical/property/experimental/search/by-dtxsid/": { - "post": { - "tags": [ - "Chemical Property Resource" - ], - "summary": "Get experimental properties for a batch of DTXSIDs", - "description": "Note: Maximum 1000 DTXSIDs per request", - "operationId": "experimentalBatchSearch", - "requestBody": { - "description": "JSON array of DSSTox Substance Identifiers", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "type": "string" - } - }, - "example": "[\"DTXSID7020182\",\"DTXSID9020112\"]" - } - }, - "required": true - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "string", - "oneOf": [ - { - "$ref": "#/components/schemas/ChemicalPropertyExperimental" - } - ] - } - } - } - }, - "400": { - "description": "User has submitted more than allowed number (1000) of DTXSID(s).", - "content": { - "application/json": { - "schema": { - "type": "string", - "oneOf": [ - { - "$ref": "#/components/schemas/ProblemDetail" - } - ] - }, - "example": { - "title": "Validation Error", - "status": 400, - "detail": "System supports requests of '200' DTXSIDs at one time, '202' are submitted." - } - } - } - } - }, - "security": [ - { - "api_key": [] - } - ] + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + } } + } }, - "/chemical/msready/search/by-mass/": { - "post": { - "tags": [ - "Chemical Search Resource" - ], - "summary": "Get MS-ready chemicals for a batch of mass ranges", - "operationId": "msReadyByBatchMass", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BatchMsReadyMassForm" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "object", - "additionalProperties": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - } - } - }, - "security": [ - { - "api_key": [] - } - ] + "security": [ + { + "api_key": [] + } + ] + } + }, + "/chemical/property/predicted/search/by-dtxsid/": { + "post": { + "tags": [ + "Chemical Property Resource" + ], + "summary": "Get predicted properties for a batch of DTXSIDs", + "description": "Note: Maximum 1000 DTXSIDs per request", + "operationId": "predictedBatchSearch", + "requestBody": { + "description": "JSON array of DSSTox Substance Identifiers", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "example": "[\"DTXSID7020182\",\"DTXSID9020112\"]" } + }, + "required": true }, - "/chemical/msready/search/by-dtxcid/": { - "post": { - "tags": [ - "Chemical Search Resource" - ], - "summary": "Get MS-ready chemicals for a batch of DTXCIDs", - "operationId": "msReadyByBatchDtxcid", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "type": "string" - } - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": {} - } - } - } - } - }, - "security": [ + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "string", + "oneOf": [ { - "api_key": [] + "$ref": "#/components/schemas/ChemicalPropertyPredicted" } - ] + ] + } + } } - }, - "/chemical/fate/search/by-dtxsid/": { - "post": { - "tags": [ - "Chemical Property Resource" - ], - "summary": "Get fate data for a batch of DTXSIDs", - "description": "return environmental fate and transport data for given DTXSID. Note: Maximum 1000 DTXSIDs per request", - "operationId": "fateBatchSearch", - "requestBody": { - "description": "JSON array of DSSTox Substance Identifier", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "type": "string" - } - }, - "example": "[\"DTXSID7020182\",\"DTXSID9020112\"]" - } - }, - "required": true - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "string", - "oneOf": [ - { - "$ref": "#/components/schemas/ChemicalFateBatchDto" - } - ] - } - } - } - }, - "400": { - "description": "User has submitted more than allowed number (1000) of DTXSID(s).", - "content": { - "application/json": { - "schema": { - "type": "string", - "oneOf": [ - { - "$ref": "#/components/schemas/ProblemDetail" - } - ] - }, - "example": { - "title": "Validation Error", - "status": 400, - "detail": "System supports requests of '200' DTXSID at one time, '202' are submitted." - } - } - } - } - }, - "security": [ + }, + "400": { + "description": "User has submitted more than allowed number (1000) of DTXSID(s).", + "content": { + "application/json": { + "schema": { + "type": "string", + "oneOf": [ { - "api_key": [] + "$ref": "#/components/schemas/ProblemDetail" } - ] + ] + }, + "example": { + "title": "Validation Error", + "status": 400, + "detail": "System supports only '200' dtxsid at one time, '202' are submitted." + } + } } + } }, - "/chemical/extra-data/search/by-dtxsid/": { - "post": { - "tags": [ - "Lit Search Data Resource" - ], - "summary": "Get data for a batch of DTXSIDs", - "description": "return data for given DTXSID", - "operationId": "batchSearchExtraData", - "requestBody": { - "description": "JSON array of DSSTox Substance Identifiers", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "type": "string" - } - }, - "example": "[\"DTXSID101296374\",\"DTXSID10612113\",\"DTXSID20635878\"]" - } - }, - "required": true - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "string", - "oneOf": [ - { - "$ref": "#/components/schemas/ExtraData" - } - ] - } - } - } - } - }, - "security": [ - { - "api_key": [] - } - ] + "security": [ + { + "api_key": [] + } + ] + } + }, + "/chemical/property/experimental/search/by-dtxsid/": { + "post": { + "tags": [ + "Chemical Property Resource" + ], + "summary": "Get experimental properties for a batch of DTXSIDs", + "description": "Note: Maximum 1000 DTXSIDs per request", + "operationId": "experimentalBatchSearch", + "requestBody": { + "description": "JSON array of DSSTox Substance Identifiers", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "example": "[\"DTXSID7020182\",\"DTXSID9020112\"]" } + }, + "required": true }, - "/chemical/detail/search/by-dtxsid/": { - "post": { - "tags": [ - "Chemical Details Resource" - ], - "summary": "Get data for a batch of DTXSIDs", - "description": "return chemical details for given DTXSIDs. Optionally, user can specify a projection (set of attributes) to return. Note: Maximum 1000 DTXSIDs per request", - "operationId": "batchDtxsidSearch", - "parameters": [ - { - "name": "projection", - "in": "query", - "required": false, - "schema": { - "$ref": "#/components/schemas/ChemicalDetailProjection", - "default": "chemicaldetailall" - } - } - ], - "requestBody": { - "description": "JSON array of DSSTox Substance Identifiers", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "type": "string" - } - }, - "example": "[\"DTXSID7020182\",\"DTXSID9020112\"]" - } - }, - "required": true - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "string", - "oneOf": [ - { - "$ref": "#/components/schemas/ChemicalDetailStandard" - }, - { - "$ref": "#/components/schemas/ChemicalIdentifier" - }, - { - "$ref": "#/components/schemas/ChemicalStructure" - } - ] - } - } - } - }, - "400": { - "description": "User submitted more than allowed number (1000) of DTXSID(s).", - "content": { - "application/problem+json": { - "schema": { - "type": "string", - "oneOf": [ - { - "$ref": "#/components/schemas/ProblemDetail" - } - ] - }, - "example": { - "title": "Validation Error", - "status": 400, - "detail": "System supports requests of '200' DTXSIDs at one time, '202' are submitted." - } - } - } - } - }, - "security": [ + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "string", + "oneOf": [ { - "api_key": [] + "$ref": "#/components/schemas/ChemicalPropertyExperimental" } - ] + ] + } + } } - }, - "/chemical/detail/search/by-dtxcid/": { - "post": { - "tags": [ - "Chemical Details Resource" - ], - "summary": "Get data for a batch of DTXCIDs", - "description": "return chemical details for given DTXCIDs. Optionally, user can specify a projection (set of attributes) to return. Note: Maximum 1000 DTXCIDs per request", - "operationId": "batchDtxcidSearch", - "parameters": [ + }, + "400": { + "description": "User has submitted more than allowed number (1000) of DTXSID(s).", + "content": { + "application/json": { + "schema": { + "type": "string", + "oneOf": [ { - "name": "projection", - "in": "query", - "required": false, - "schema": { - "$ref": "#/components/schemas/ChemicalDetailProjection", - "default": "chemicaldetailall" - } - } - ], - "requestBody": { - "description": "JSON array of DSSTox Compound Identifiers", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "type": "string" - } - }, - "example": "[\"DTXCID505\",\"DTXSID9020112\"]" - } - }, - "required": true - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "string", - "oneOf": [ - { - "$ref": "#/components/schemas/ChemicalDetailStandard" - }, - { - "$ref": "#/components/schemas/ChemicalIdentifier" - }, - { - "$ref": "#/components/schemas/ChemicalStructure" - } - ] - } - } - } - }, - "400": { - "description": "User has submitted more than allowed number (1000) of DTXCID(s).", - "content": { - "application/problem+json": { - "schema": { - "type": "string", - "oneOf": [ - { - "$ref": "#/components/schemas/ProblemDetail" - } - ] - }, - "example": { - "title": "Validation Error", - "status": 400, - "detail": "System supports requests of '${application.batch-size}' DTXSIDs at one time, '${application.batch-size+1}' are submitted." - } - } - } + "$ref": "#/components/schemas/ProblemDetail" } + ] }, - "security": [ - { - "api_key": [] - } - ] + "example": { + "title": "Validation Error", + "status": 400, + "detail": "System supports requests of '200' DTXSIDs at one time, '202' are submitted." + } + } } + } }, - "/chemical/synonym/search/by-dtxsid/{dtxsid}": { - "get": { - "tags": [ - "Chemical Synonym Resource" - ], - "summary": "Get synonyms by DTXSID", - "description": "return synonyms by DTXSID. Projections available include: ccd-synonyms (flat list) and chemical-synonym-all (default structured view).", - "operationId": "getSynonymsByDtxsid", - "parameters": [ - { - "name": "dtxsid", - "in": "path", - "description": "DSSTox Substance Identifier", - "required": true, - "schema": { - "type": "string" - }, - "example": "DTXSID7020182" - }, - { - "name": "projection", - "in": "query", - "description": "Projections available include: ccd-synonyms and chemical-synonym-all. By default, chemical-synonym-all will be returned.", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "string", - "oneOf": [ - { - "$ref": "#/components/schemas/ChemicalSynonymAll" - }, - { - "$ref": "#/components/schemas/CcdSynonymFlatProjection" - } - ] - } - } - } - } - }, - "security": [ - { - "api_key": [] - } - ] + "security": [ + { + "api_key": [] + } + ] + } + }, + "/chemical/msready/search/by-mass/": { + "post": { + "tags": [ + "Chemical Search Resource" + ], + "summary": "Get MS-ready chemicals for a batch of mass ranges", + "operationId": "msReadyByBatchMass", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/BatchMsReadyMassForm" + } } + }, + "required": true }, - "/chemical/search/start-with/{word}": { - "get": { - "tags": [ - "Chemical Search Resource" - ], - "summary": "Get chemicals by starting value", - "description": "return chemical(s) if starts with searched value.", - "operationId": "chemicalStartWith", - "parameters": [ - { - "name": "word", - "in": "path", - "description": "Starting string of word to search for. Values supplied as the 'word' parameter can include chemical name, DTXSID, DTXCID, CAS Registry Number (CASRN), or InChIKey.", - "required": true, - "schema": { - "type": "string" - }, - "examples": { - "DSSTox Substance Identifier": { - "description": "DSSTox Substance Identifier", - "value": "DTXSID7020182" - }, - "CASRN": { - "description": "CASRN", - "value": "1912-24" - } - } - }, - { - "name": "top", - "in": "query", - "required": false, - "schema": { - "type": "integer", - "format": "int32", - "default": 500 - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "string", - "oneOf": [ - { - "$ref": "#/components/schemas/ChemicalSearchAll" - } - ] - } - } - } - }, - "400": { - "description": "Data not found.", - "content": { - "application/problem+json": { - "schema": { - "type": "string", - "oneOf": [ - { - "$ref": "#/components/schemas/ProblemDetail" - } - ] - } - } - } - } - }, - "security": [ - { - "api_key": [] - } - ] + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": { + "type": "array", + "items": { + "type": "string" + } + } + } + } } + } }, - "/chemical/search/equal/{word}": { - "get": { - "tags": [ - "Chemical Search Resource" - ], - "summary": "Get chemicals by exact value", - "description": "return chemical(s) if matches exact searched value.", - "operationId": "chemicalEqual", - "parameters": [ - { - "name": "word", - "in": "path", - "description": "Exact string of word to search for. Values supplied as the 'word' parameter can include chemical name, DTXSID, DTXCID, CAS Registry Number (CASRN), or InChIKey.", - "required": true, - "schema": { - "type": "string" - }, - "examples": { - "DSSTox Substance Identifier": { - "description": "DSSTox Substance Identifier", - "value": "DTXSID7020182" - }, - "CASRN": { - "description": "CASRN", - "value": "1912-24-9" - } - } - }, - { - "name": "projection", - "in": "query", - "required": false, - "schema": { - "type": "string", - "default": "chemicalsearchall" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "string", - "oneOf": [ - { - "$ref": "#/components/schemas/ChemicalSearchAll" - } - ] - } - } - } - }, - "400": { - "description": "Data not found.", - "content": { - "application/problem+json": { - "schema": { - "type": "string", - "oneOf": [ - { - "$ref": "#/components/schemas/ProblemDetail" - } - ] - } - } - } - } - }, - "security": [ - { - "api_key": [] - } - ] + "security": [ + { + "api_key": [] + } + ] + } + }, + "/chemical/msready/search/by-dtxcid/": { + "post": { + "tags": [ + "Chemical Search Resource" + ], + "summary": "Get MS-ready chemicals for a batch of DTXCIDs", + "operationId": "msReadyByBatchDtxcid", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "string" + } + } } + }, + "required": true }, - "/chemical/search/contain/{word}": { - "get": { - "tags": [ - "Chemical Search Resource" - ], - "summary": "Get chemicals by substring value", - "description": "return chemical(s) if contains searched value.", - "operationId": "chemicalContain", - "parameters": [ - { - "name": "word", - "in": "path", - "description": "Substring of word to seach for. Values supplied as the 'word' parameter can include chemical name, DTXSID, DTXCID, CAS Registry Number (CASRN), or InChIKey.", - "required": true, - "schema": { - "type": "string" - }, - "examples": { - "DSSTox Compound Identifier": { - "description": "DSSTox Compound Identifier", - "value": "DTXCID505" - }, - "Synonym": { - "description": "Synonym", - "value": "razine" - } - } - }, - { - "name": "top", - "in": "query", - "required": false, - "schema": { - "type": "integer", - "format": "int32", - "default": 0 - } - }, - { - "name": "projection", - "in": "query", - "required": false, - "schema": { - "type": "string", - "default": "chemicalsearchall" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "string", - "oneOf": [ - { - "$ref": "#/components/schemas/ChemicalSearchAll" - } - ] - } - } - } - }, - "400": { - "description": "Data not found.", - "content": { - "application/problem+json": { - "schema": { - "type": "string", - "oneOf": [ - { - "$ref": "#/components/schemas/ProblemDetail" - } - ] - } - } - } - } - }, - "security": [ - { - "api_key": [] - } - ] + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + + } + } + } } + } }, - "/chemical/search/by-msready-formula/{formula}": { - "get": { - "tags": [ - "Chemical Search Resource" - ], - "summary": "Get chemicals by MS-ready formula", - "operationId": "getChemicalsForMsreadyFormula", - "parameters": [ - { - "name": "formula", - "in": "path", - "description": "Chemical formula", - "required": true, - "schema": { - "type": "string" - }, - "example": "C15H16O2" - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - } - }, - "security": [ - { - "api_key": [] - } - ] + "security": [ + { + "api_key": [] + } + ] + } + }, + "/chemical/ghslink/to-dtxsid/": { + "post": { + "tags": [ + "PubChem to GHS Classification Resource" + ], + "summary": "Check for link for a batch of DTXSIDs", + "description": "This endpoint will return Y if Pubchem has GHS Safety data, otherwise N.", + "operationId": "byBatchDtxsid_1", + "requestBody": { + "description": "JSON array of DSSTox Substance Identifiers", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "example": "[\"DTXSID7020182\",\"DTXSID9020112\"]" } + }, + "required": true }, - "/chemical/search/by-exact-formula/{formula}": { - "get": { - "tags": [ - "Chemical Search Resource" - ], - "summary": "Get chemicals by exact formula", - "operationId": "getChemicalsForExactFormula", - "parameters": [ - { - "name": "formula", - "in": "path", - "description": "Chemical formula", - "required": true, - "schema": { - "type": "string" - }, - "example": "C15H16O2" - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - } - }, - "security": [ - { - "api_key": [] - } - ] + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GhsLinkResponse" + } + } + } } + } }, - "/chemical/property/summary/search/by-dtxsid/{dtxsid}": { - "get": { - "tags": [ - "Chemical Property Resource" - ], - "summary": "Get summary by DTXSID", - "description": "return property summary for given DTXSID", - "operationId": "propertySummaryByDtxsid", - "parameters": [ - { - "name": "dtxsid", - "in": "path", - "description": "DSSTox Substance Identifier", - "required": true, - "schema": { - "type": "string" - }, - "example": "DTXSID7020182" - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "string", - "oneOf": [ - { - "$ref": "#/components/schemas/ChemicalPropertySummary" - } - ] - } - } - } - } - }, - "security": [ - { - "api_key": [] - } - ] + "security": [ + { + "api_key": [] + } + ] + } + }, + "/chemical/fate/search/by-dtxsid/": { + "post": { + "tags": [ + "Chemical Property Resource" + ], + "summary": "Get fate data for a batch of DTXSIDs", + "description": "return environmental fate and transport data for given DTXSID. Note: Maximum 1000 DTXSIDs per request", + "operationId": "fateBatchSearch", + "requestBody": { + "description": "JSON array of DSSTox Substance Identifier", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "example": "[\"DTXSID7020182\",\"DTXSID9020112\"]" } + }, + "required": true }, - "/chemical/property/summary/search/": { - "get": { - "tags": [ - "Chemical Property Resource" - ], - "summary": "Get summary by DTXSID and property", - "description": "return property summary for given DTXSID and property", - "operationId": "propertySummaryByDtxsidAndName", - "parameters": [ - { - "name": "dtxsid", - "in": "query", - "required": true, - "schema": { - "type": "string" - } - }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "string", + "oneOf": [ { - "name": "propName", - "in": "query", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/schemas/ChemicalFateBatchDto" } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "string", - "oneOf": [ - { - "$ref": "#/components/schemas/ChemicalPropertySummary" - } - ] - } - } - } - } - }, - "security": [ - { - "api_key": [] - } - ] + ] + } + } } - }, - "/chemical/property/summary/predicted/search/": { - "get": { - "tags": [ - "Chemical Property Resource" - ], - "summary": "Get predicted property summary by DTXSID and property", - "description": "return predicted property summary for given DTXSID and property", - "operationId": "propertySummaryPredictedByDtxsidAndName", - "parameters": [ - { - "name": "dtxsid", - "in": "query", - "required": true, - "schema": { - "type": "string" - } - }, + }, + "400": { + "description": "User has submitted more than allowed number (1000) of DTXSID(s).", + "content": { + "application/json": { + "schema": { + "type": "string", + "oneOf": [ { - "name": "propName", - "in": "query", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "string", - "oneOf": [ - { - "$ref": "#/components/schemas/ChemicalPropertySummaryExperimental" - } - ] - } - } - } + "$ref": "#/components/schemas/ProblemDetail" } + ] }, - "security": [ - { - "api_key": [] - } - ] + "example": { + "title": "Validation Error", + "status": 400, + "detail": "System supports requests of '200' DTXSID at one time, '202' are submitted." + } + } } + } }, - "/chemical/property/summary/experimental/search/": { - "get": { - "tags": [ - "Chemical Property Resource" - ], - "summary": "Get experimental summary by DTXSID and property", - "description": "return experimental property summary for given DTXSID and property", - "operationId": "propertySummaryExperimentalByDtxsidAndName", - "parameters": [ - { - "name": "dtxsid", - "in": "query", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "propName", - "in": "query", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "string", - "oneOf": [ - { - "$ref": "#/components/schemas/ChemicalPropertySummaryExperimental" - } - ] - } - } - } - } - }, - "security": [ + "security": [ + { + "api_key": [] + } + ] + } + }, + "/chemical/extra-data/search/by-dtxsid/": { + "post": { + "tags": [ + "Lit Search Data Resource" + ], + "summary": "Get data for a batch of DTXSIDs", + "description": "return data for given DTXSID", + "operationId": "batchSearchExtraData", + "requestBody": { + "description": "JSON array of DSSTox Substance Identifiers", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "example": "[\"DTXSID101296374\",\"DTXSID10612113\",\"DTXSID20635878\"]" + } + }, + "required": true + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "string", + "oneOf": [ { - "api_key": [] + "$ref": "#/components/schemas/ExtraData" } - ] + ] + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/chemical/detail/search/by-dtxsid/": { + "post": { + "tags": [ + "Chemical Details Resource" + ], + "summary": "Get data for a batch of DTXSIDs", + "description": "return chemical details for given DTXSIDs. Optionally, user can specify a projection (set of attributes) to return. Note: Maximum 1000 DTXSIDs per request", + "operationId": "batchDtxsidSearch", + "parameters": [ + { + "name": "projection", + "in": "query", + "required": false, + "schema": { + "$ref": "#/components/schemas/ChemicalDetailProjection", + "default": "chemicaldetailall" + } + } + ], + "requestBody": { + "description": "JSON array of DSSTox Substance Identifiers", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "example": "[\"DTXSID7020182\",\"DTXSID9020112\"]" } + }, + "required": true }, - "/chemical/property/predicted/search/by-range/{propertyId}/{start}/{end}": { - "get": { - "tags": [ - "Chemical Property Resource" - ], - "summary": "Get predicted properties by property and range", - "description": "return predicted properties by specifying the propertyName, start, and end values.", - "operationId": "predictedPropertyByRange", - "parameters": [ + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "string", + "oneOf": [ { - "name": "propertyId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/schemas/ChemicalDetailStandard" }, { - "name": "start", - "in": "path", - "required": true, - "schema": { - "type": "number", - "format": "double" - } + "$ref": "#/components/schemas/ChemicalIdentifier" }, { - "name": "end", - "in": "path", - "required": true, - "schema": { - "type": "number", - "format": "double" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "string", - "oneOf": [ - { - "$ref": "#/components/schemas/ChemicalPropertyPredicted" - } - ] - } - } - } - } - }, - "security": [ - { - "api_key": [] + "$ref": "#/components/schemas/ChemicalStructure" } - ] + ] + } + } } - }, - "/chemical/property/predicted/search/by-dtxsid/{dtxsid}": { - "get": { - "tags": [ - "Chemical Property Resource" - ], - "summary": "Get predicted properties by DTXSID", - "description": "return predicted properties for given DTXSID", - "operationId": "predictedPropertyByDtxsid", - "parameters": [ + }, + "400": { + "description": "User submitted more than allowed number (1000) of DTXSID(s).", + "content": { + "application/problem+json": { + "schema": { + "type": "string", + "oneOf": [ { - "name": "dtxsid", - "in": "path", - "description": "DSSTox Substance Identifier", - "required": true, - "schema": { - "type": "string" - }, - "example": "DTXSID7020182" - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "string", - "oneOf": [ - { - "$ref": "#/components/schemas/ChemicalPropertyPredicted" - } - ] - } - } - } + "$ref": "#/components/schemas/ProblemDetail" } + ] }, - "security": [ - { - "api_key": [] - } - ] + "example": { + "title": "Validation Error", + "status": 400, + "detail": "System supports requests of '200' DTXSIDs at one time, '202' are submitted." + } + } } + } }, - "/chemical/property/predicted/name": { - "get": { - "tags": [ - "Chemical Property Resource" - ], - "summary": "Get all predicted property options", - "operationId": "predictedPropertyNames", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "string", - "oneOf": [ - { - "$ref": "#/components/schemas/ChemicalPropertyName" - } - ] - } - } - } - } - }, - "security": [ - { - "api_key": [] - } - ] + "security": [ + { + "api_key": [] + } + ] + } + }, + "/chemical/detail/search/by-dtxcid/": { + "post": { + "tags": [ + "Chemical Details Resource" + ], + "summary": "Get data for a batch of DTXCIDs", + "description": "return chemical details for given DTXCIDs. Optionally, user can specify a projection (set of attributes) to return. Note: Maximum 1000 DTXCIDs per request", + "operationId": "batchDtxcidSearch", + "parameters": [ + { + "name": "projection", + "in": "query", + "required": false, + "schema": { + "$ref": "#/components/schemas/ChemicalDetailProjection", + "default": "chemicaldetailall" + } + } + ], + "requestBody": { + "description": "JSON array of DSSTox Compound Identifiers", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "example": "[\"DTXCID505\",\"DTXSID9020112\"]" } + }, + "required": true }, - "/chemical/property/experimental/search/by-range/{propertyName}/{start}/{end}": { - "get": { - "tags": [ - "Chemical Property Resource" - ], - "summary": "Get experimental properties by property and range", - "description": "return experimental properties by specifying the propertyName, start, and end values", - "operationId": "experimentalPropertyByRange", - "parameters": [ + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "string", + "oneOf": [ { - "name": "propertyName", - "in": "path", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/schemas/ChemicalDetailStandard" }, { - "name": "start", - "in": "path", - "required": true, - "schema": { - "type": "number", - "format": "double" - } + "$ref": "#/components/schemas/ChemicalIdentifier" }, { - "name": "end", - "in": "path", - "required": true, - "schema": { - "type": "number", - "format": "double" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "string", - "oneOf": [ - { - "$ref": "#/components/schemas/ChemicalPropertyExperimental" - } - ] - } - } - } - } - }, - "security": [ - { - "api_key": [] + "$ref": "#/components/schemas/ChemicalStructure" } - ] + ] + } + } } - }, - "/chemical/property/experimental/search/by-dtxsid/{dtxsid}": { - "get": { - "tags": [ - "Chemical Property Resource" - ], - "summary": "Get experimental properties by DTXSID", - "description": "return experimental properties for given DTXSID", - "operationId": "experimentalPropertyByDtxsid", - "parameters": [ + }, + "400": { + "description": "User has submitted more than allowed number (1000) of DTXCID(s).", + "content": { + "application/problem+json": { + "schema": { + "type": "string", + "oneOf": [ { - "name": "dtxsid", - "in": "path", - "description": "DSSTox Substance Identifier", - "required": true, - "schema": { - "type": "string" - }, - "example": "DTXSID7020182" - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "string", - "oneOf": [ - { - "$ref": "#/components/schemas/ChemicalPropertyExperimental" - } - ] - } - } - } + "$ref": "#/components/schemas/ProblemDetail" } + ] }, - "security": [ - { - "api_key": [] - } - ] + "example": { + "title": "Validation Error", + "status": 400, + "detail": "System supports requests of '${application.batch-size}' DTXSIDs at one time, '${application.batch-size+1}' are submitted." + } + } } + } }, - "/chemical/property/experimental/name": { - "get": { - "tags": [ - "Chemical Property Resource" - ], - "summary": "Get all experimental property options", - "operationId": "experimentalPropertyNames", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "string", - "oneOf": [ - { - "$ref": "#/components/schemas/ChemicalPropertyName" - } - ] - } - } - } - } - }, - "security": [ - { - "api_key": [] - } - ] + "security": [ + { + "api_key": [] + } + ] + } + }, + "/chemical/wikipedia/by-dtxsid/{dtxsid}": { + "get": { + "tags": [ + "Wikipedia to GHS Classification Resource" + ], + "summary": "Check for link by DTXSID", + "description": "This endpoint will return Y if Wikipedia has GHS Safety data, otherwise N.", + "operationId": "byDtxsid", + "parameters": [ + { + "name": "dtxsid", + "in": "path", + "description": "DSSTox Substance Identifier", + "required": true, + "schema": { + "type": "string" + }, + "example": "DTXSID7020182" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/WikipediaLinkResponse" + } + } } + } }, - "/chemical/msready/search/by-mass/{start}/{end}": { - "get": { - "tags": [ - "Chemical Search Resource" - ], - "summary": "Get MS-ready chemicals using mass range", - "operationId": "msReadyByMass", - "parameters": [ + "security": [ + { + "api_key": [] + } + ] + } + }, + "/chemical/synonym/search/by-dtxsid/{dtxsid}": { + "get": { + "tags": [ + "Chemical Synonym Resource" + ], + "summary": "Get synonyms by DTXSID", + "description": "return synonyms by DTXSID. Projections available include: ccd-synonyms (flat list) and chemical-synonym-all (default structured view).", + "operationId": "getSynonymsByDtxsid", + "parameters": [ + { + "name": "dtxsid", + "in": "path", + "description": "DSSTox Substance Identifier", + "required": true, + "schema": { + "type": "string" + }, + "example": "DTXSID7020182" + }, + { + "name": "projection", + "in": "query", + "description": "Projections available include: ccd-synonyms and chemical-synonym-all. By default, chemical-synonym-all will be returned.", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "string", + "oneOf": [ { - "name": "start", - "in": "path", - "description": "Starting mass value", - "required": true, - "schema": { - "type": "number", - "format": "double" - }, - "example": 200.9 + "$ref": "#/components/schemas/ChemicalSynonymAll" }, { - "name": "end", - "in": "path", - "description": "Ending mass value", - "required": true, - "schema": { - "type": "number", - "format": "double" - }, - "example": 200.95 - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - } - }, - "security": [ - { - "api_key": [] + "$ref": "#/components/schemas/CcdSynonymFlatProjection" } - ] + ] + } + } } + } }, - "/chemical/msready/search/by-formula/{formula}": { - "get": { - "tags": [ - "Chemical Search Resource" - ], - "summary": "Get MS-ready chemicals by formula", - "operationId": "msReadyByFormula", - "parameters": [ + "security": [ + { + "api_key": [] + } + ] + } + }, + "/chemical/search/start-with/{word}": { + "get": { + "tags": [ + "Chemical Search Resource" + ], + "summary": "Get chemicals by starting value", + "description": "return chemical(s) if starts with searched value.", + "operationId": "chemicalStartWith", + "parameters": [ + { + "name": "word", + "in": "path", + "description": "Starting string of word to search for. Values supplied as the 'word' parameter can include chemical name, DTXSID, DTXCID, CAS Registry Number (CASRN), or InChIKey.", + "required": true, + "schema": { + "type": "string" + }, + "examples": { + "DSSTox Substance Identifier": { + "description": "DSSTox Substance Identifier", + "value": "DTXSID7020182" + }, + "CASRN": { + "description": "CASRN", + "value": "1912-24" + } + } + }, + { + "name": "top", + "in": "query", + "required": false, + "schema": { + "type": "integer", + "format": "int32", + "default": 500 + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "string", + "oneOf": [ { - "name": "formula", - "in": "path", - "description": "Chemical formula", - "required": true, - "schema": { - "type": "string" - }, - "example": "C16H24N2O5S" + "$ref": "#/components/schemas/ChemicalSearchAll" } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - } - }, - "security": [ + ] + } + } + } + }, + "400": { + "description": "Data not found.", + "content": { + "application/problem+json": { + "schema": { + "type": "string", + "oneOf": [ { - "api_key": [] + "$ref": "#/components/schemas/ProblemDetail" } - ] + ] + } + } } + } }, - "/chemical/msready/search/by-dtxcid/{dtxcid}": { - "get": { - "tags": [ - "Chemical Search Resource" - ], - "summary": "Get MS-ready chemicals by DTXCID", - "operationId": "msReadyByDtxcid", - "parameters": [ + "security": [ + { + "api_key": [] + } + ] + } + }, + "/chemical/search/equal/{word}": { + "get": { + "tags": [ + "Chemical Search Resource" + ], + "summary": "Get chemicals by exact value", + "description": "return chemical(s) if matches exact searched value.", + "operationId": "chemicalEqual", + "parameters": [ + { + "name": "word", + "in": "path", + "description": "Exact string of word to search for. Values supplied as the 'word' parameter can include chemical name, DTXSID, DTXCID, CAS Registry Number (CASRN), or InChIKey.", + "required": true, + "schema": { + "type": "string" + }, + "examples": { + "DSSTox Substance Identifier": { + "description": "DSSTox Substance Identifier", + "value": "DTXSID7020182" + }, + "CASRN": { + "description": "CASRN", + "value": "1912-24-9" + } + } + }, + { + "name": "projection", + "in": "query", + "required": false, + "schema": { + "type": "string", + "default": "chemicalsearchall" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "string", + "oneOf": [ { - "name": "dtxcid", - "in": "path", - "description": "DSSTox Compound Identifier", - "required": true, - "schema": { - "type": "string" - }, - "example": "DTXCID30182" - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "type": "string" - } - } - } - } + "$ref": "#/components/schemas/ChemicalSearchAll" } - }, - "security": [ + ] + } + } + } + }, + "400": { + "description": "Data not found.", + "content": { + "application/problem+json": { + "schema": { + "type": "string", + "oneOf": [ { - "api_key": [] + "$ref": "#/components/schemas/ProblemDetail" } - ] + ] + } + } } + } }, - "/chemical/list/type": { - "get": { - "tags": [ - "Chemical List Resource" - ], - "summary": "Get all list types", - "operationId": "getAllType", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - } - }, - "security": [ - { - "api_key": [] - } - ] + "security": [ + { + "api_key": [] + } + ] + } + }, + "/chemical/search/contain/{word}": { + "get": { + "tags": [ + "Chemical Search Resource" + ], + "summary": "Get chemicals by substring value", + "description": "return chemical(s) if contains searched value.", + "operationId": "chemicalContain", + "parameters": [ + { + "name": "word", + "in": "path", + "description": "Substring of word to seach for. Values supplied as the 'word' parameter can include chemical name, DTXSID, DTXCID, CAS Registry Number (CASRN), or InChIKey.", + "required": true, + "schema": { + "type": "string" + }, + "examples": { + "DSSTox Compound Identifier": { + "description": "DSSTox Compound Identifier", + "value": "DTXCID505" + }, + "Synonym": { + "description": "Synonym", + "value": "razine" + } } - }, - "/chemical/list/search/by-type/{type}": { - "get": { - "tags": [ - "Chemical List Resource" - ], - "summary": "Get lists by list type", - "operationId": "listByType", - "parameters": [ - { - "name": "type", - "in": "path", - "description": "Chemical List Type", - "required": true, - "schema": { - "type": "string" - }, - "example": "other" - }, + }, + { + "name": "top", + "in": "query", + "required": false, + "schema": { + "type": "integer", + "format": "int32", + "default": 0 + } + }, + { + "name": "projection", + "in": "query", + "required": false, + "schema": { + "type": "string", + "default": "chemicalsearchall" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "string", + "oneOf": [ { - "name": "projection", - "in": "query", - "required": false, - "schema": { - "$ref": "#/components/schemas/ChemicalListProjection", - "default": "chemicallistall" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "string", - "oneOf": [ - { - "$ref": "#/components/schemas/ChemicalList" - }, - { - "$ref": "#/components/schemas/ChemicalListName" - } - ] - } - } - } + "$ref": "#/components/schemas/ChemicalSearchAll" } - }, - "security": [ + ] + } + } + } + }, + "400": { + "description": "Data not found.", + "content": { + "application/problem+json": { + "schema": { + "type": "string", + "oneOf": [ { - "api_key": [] + "$ref": "#/components/schemas/ProblemDetail" } - ] + ] + } + } } + } }, - "/chemical/list/search/by-name/{listName}": { - "get": { - "tags": [ - "Chemical List Resource" - ], - "summary": "Get lists by name", - "operationId": "listByName", - "parameters": [ - { - "name": "listName", - "in": "path", - "description": "Chemical List Name", - "required": true, - "schema": { - "type": "string" - }, - "example": "40CFR1164" - }, - { - "name": "projection", - "in": "query", - "required": false, - "schema": { - "$ref": "#/components/schemas/ChemicalListProjection", - "default": "chemicallistall" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "string", - "oneOf": [ - { - "$ref": "#/components/schemas/ChemicalList" - }, - { - "$ref": "#/components/schemas/ChemicalListWithDtxsids" - } - ] - } - } - } - } - }, - "security": [ - { - "api_key": [] - } - ] + "security": [ + { + "api_key": [] + } + ] + } + }, + "/chemical/search/by-msready-formula/{formula}": { + "get": { + "tags": [ + "Chemical Search Resource" + ], + "summary": "Get chemicals by MS-ready formula", + "operationId": "getChemicalsForMsreadyFormula", + "parameters": [ + { + "name": "formula", + "in": "path", + "description": "Chemical formula", + "required": true, + "schema": { + "type": "string" + }, + "example": "C15H16O2" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + } } + } }, - "/chemical/list/search/by-dtxsid/{dtxsid}": { - "get": { - "tags": [ - "Chemical List Resource" - ], - "summary": "Get lists containing DTXSID", - "operationId": "listByDtxsid", - "parameters": [ - { - "name": "dtxsid", - "in": "path", - "description": "DSSTox Substance Identifier", - "required": true, - "schema": { - "type": "string" - }, - "example": "DTXSID1020560" - }, - { - "name": "projection", - "in": "query", - "required": false, - "schema": { - "$ref": "#/components/schemas/ChemicalListProjection", - "default": "chemicallistall" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "string", - "oneOf": [ - { - "$ref": "#/components/schemas/ChemicalList" - }, - { - "$ref": "#/components/schemas/ChemicalListName" - } - ] - } - } - } - } - }, - "security": [ - { - "api_key": [] - } - ] + "security": [ + { + "api_key": [] + } + ] + } + }, + "/chemical/search/by-exact-formula/{formula}": { + "get": { + "tags": [ + "Chemical Search Resource" + ], + "summary": "Get chemicals by exact formula", + "operationId": "getChemicalsForExactFormula", + "parameters": [ + { + "name": "formula", + "in": "path", + "description": "Chemical formula", + "required": true, + "schema": { + "type": "string" + }, + "example": "C15H16O2" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + } } + } }, - "/chemical/list/chemicals/search/start-with/{list}/{word}": { - "get": { - "tags": [ - "Chemical List Resource" - ], - "summary": "Get DTXSIDs for list and containing starting string in chemical name", - "operationId": "startWith", - "parameters": [ - { - "name": "list", - "in": "path", - "description": "List Name", - "required": true, - "schema": { - "type": "string" - }, - "example": "40CFR1164" - }, - { - "name": "word", - "in": "path", - "description": "Chemical Name", - "required": true, - "schema": { - "type": "string" - }, - "example": "ammo" - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - } - }, - "security": [ + "security": [ + { + "api_key": [] + } + ] + } + }, + "/chemical/property/summary/search/by-dtxsid/{dtxsid}": { + "get": { + "tags": [ + "Chemical Property Resource" + ], + "summary": "Get summary by DTXSID", + "description": "return property summary for given DTXSID", + "operationId": "propertySummaryByDtxsid", + "parameters": [ + { + "name": "dtxsid", + "in": "path", + "description": "DSSTox Substance Identifier", + "required": true, + "schema": { + "type": "string" + }, + "example": "DTXSID7020182" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "string", + "oneOf": [ { - "api_key": [] + "$ref": "#/components/schemas/ChemicalPropertySummary" } - ] + ] + } + } } + } }, - "/chemical/list/chemicals/search/equal/{list}/{word}": { - "get": { - "tags": [ - "Chemical List Resource" - ], - "summary": "Get DTXSIDs for list and containing exact string in chemical name", - "operationId": "exact", - "parameters": [ - { - "name": "list", - "in": "path", - "description": "List Name", - "required": true, - "schema": { - "type": "string" - }, - "example": "40CFR1164" - }, - { - "name": "word", - "in": "path", - "description": "Chemical Name", - "required": true, - "schema": { - "type": "string" - }, - "example": "AMMONIA" - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - } - }, - "security": [ + "security": [ + { + "api_key": [] + } + ] + } + }, + "/chemical/property/summary/search/": { + "get": { + "tags": [ + "Chemical Property Resource" + ], + "summary": "Get summary by DTXSID and property", + "description": "return property summary for given DTXSID and property", + "operationId": "propertySummaryByDtxsidAndName", + "parameters": [ + { + "name": "dtxsid", + "in": "query", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "propName", + "in": "query", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "string", + "oneOf": [ { - "api_key": [] + "$ref": "#/components/schemas/ChemicalPropertySummary" } - ] + ] + } + } } + } }, - "/chemical/list/chemicals/search/contain/{list}/{word}": { - "get": { - "tags": [ - "Chemical List Resource" - ], - "summary": "Get DTXSIDs for list and containing substring in chemical name", - "operationId": "contain", - "parameters": [ - { - "name": "list", - "in": "path", - "description": "List Name", - "required": true, - "schema": { - "type": "string" - }, - "example": "40CFR1164" - }, - { - "name": "word", - "in": "path", - "description": "Chemical Name", - "required": true, - "schema": { - "type": "string" - }, - "example": "MONIA" - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - } - }, - "security": [ + "security": [ + { + "api_key": [] + } + ] + } + }, + "/chemical/property/summary/predicted/search/": { + "get": { + "tags": [ + "Chemical Property Resource" + ], + "summary": "Get predicted property summary by DTXSID and property", + "description": "return predicted property summary for given DTXSID and property", + "operationId": "propertySummaryPredictedByDtxsidAndName", + "parameters": [ + { + "name": "dtxsid", + "in": "query", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "propName", + "in": "query", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "string", + "oneOf": [ { - "api_key": [] + "$ref": "#/components/schemas/ChemicalPropertySummaryExperimental" } - ] + ] + } + } } + } }, - "/chemical/list/chemicals/search/by-listname/{list}": { - "get": { - "tags": [ - "Chemical List Resource" - ], - "summary": "Get DTXSIDs by list", - "operationId": "listDtxsids", - "parameters": [ - { - "name": "list", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "example": "40CFR1164" - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - } - }, - "security": [ + "security": [ + { + "api_key": [] + } + ] + } + }, + "/chemical/property/summary/experimental/search/": { + "get": { + "tags": [ + "Chemical Property Resource" + ], + "summary": "Get experimental summary by DTXSID and property", + "description": "return experimental property summary for given DTXSID and property", + "operationId": "propertySummaryExperimentalByDtxsidAndName", + "parameters": [ + { + "name": "dtxsid", + "in": "query", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "propName", + "in": "query", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "string", + "oneOf": [ { - "api_key": [] + "$ref": "#/components/schemas/ChemicalPropertySummaryExperimental" } - ] + ] + } + } } + } }, - "/chemical/list/all": { - "get": { - "tags": [ - "Chemical List Resource" - ], - "summary": "Get all lists", - "operationId": "listAll", - "parameters": [ - { - "name": "projection", - "in": "query", - "required": false, - "schema": { - "$ref": "#/components/schemas/ChemicalListProjection", - "default": "chemicallistall" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "string", - "oneOf": [ - { - "$ref": "#/components/schemas/ChemicalList" - }, - { - "$ref": "#/components/schemas/ChemicalListName" - } - ] - } - } - } - } - }, - "security": [ + "security": [ + { + "api_key": [] + } + ] + } + }, + "/chemical/property/predicted/search/by-range/{propertyId}/{start}/{end}": { + "get": { + "tags": [ + "Chemical Property Resource" + ], + "summary": "Get predicted properties by property and range", + "description": "return predicted properties by specifying the propertyName, start, and end values.", + "operationId": "predictedPropertyByRange", + "parameters": [ + { + "name": "propertyId", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "start", + "in": "path", + "required": true, + "schema": { + "type": "number", + "format": "double" + } + }, + { + "name": "end", + "in": "path", + "required": true, + "schema": { + "type": "number", + "format": "double" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "string", + "oneOf": [ { - "api_key": [] + "$ref": "#/components/schemas/ChemicalPropertyPredicted" } - ] + ] + } + } } + } }, - "/chemical/file/mol/search/by-dtxsid/{dtxsid}": { - "get": { - "tags": [ - "Chemical File Resource" - ], - "summary": "Get mol file by DTXSID", - "description": "return mol file for given DTXSID", - "operationId": "molByDtxsid", - "parameters": [ - { - "name": "dtxsid", - "in": "path", - "description": "DSSTox Substance Identifier", - "required": true, - "schema": { - "type": "string" - }, - "example": "DTXSID7020182" - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": {} - } - } - }, - "security": [ + "security": [ + { + "api_key": [] + } + ] + } + }, + "/chemical/property/predicted/search/by-dtxsid/{dtxsid}": { + "get": { + "tags": [ + "Chemical Property Resource" + ], + "summary": "Get predicted properties by DTXSID", + "description": "return predicted properties for given DTXSID", + "operationId": "predictedPropertyByDtxsid", + "parameters": [ + { + "name": "dtxsid", + "in": "path", + "description": "DSSTox Substance Identifier", + "required": true, + "schema": { + "type": "string" + }, + "example": "DTXSID7020182" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "string", + "oneOf": [ { - "api_key": [] + "$ref": "#/components/schemas/ChemicalPropertyPredicted" } - ] + ] + } + } } + } }, - "/chemical/file/mol/search/by-dtxcid/{dtxcid}": { - "get": { - "tags": [ - "Chemical File Resource" - ], - "summary": "Get mol file by DTXCID", - "description": "return mol file for given DTXCID", - "operationId": "molByDtxcid", - "parameters": [ - { - "name": "dtxcid", - "in": "path", - "description": "DSSTox Compound Identifier", - "required": true, - "schema": { - "type": "string" - }, - "example": "DTXCID505" - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": {} - } - } - }, - "security": [ + "security": [ + { + "api_key": [] + } + ] + } + }, + "/chemical/property/predicted/name": { + "get": { + "tags": [ + "Chemical Property Resource" + ], + "summary": "Get all predicted property options", + "operationId": "predictedPropertyNames", + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "string", + "oneOf": [ { - "api_key": [] + "$ref": "#/components/schemas/ChemicalPropertyName" } - ] + ] + } + } } + } }, - "/chemical/file/image/search/by-gsid/{gsid}": { - "get": { - "tags": [ - "Chemical File Resource" - ], - "summary": "Get structure image by GSID", - "description": "return structure image for given GSID", - "operationId": "imageByGsid", - "parameters": [ - { - "name": "gsid", - "in": "path", - "description": "Generic Substance Id", - "required": true, - "schema": { - "type": "string" - }, - "example": 20182 - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "image/png": {} - } - } - }, - "security": [ + "security": [ + { + "api_key": [] + } + ] + } + }, + "/chemical/property/experimental/search/by-range/{propertyName}/{start}/{end}": { + "get": { + "tags": [ + "Chemical Property Resource" + ], + "summary": "Get experimental properties by property and range", + "description": "return experimental properties by specifying the propertyName, start, and end values", + "operationId": "experimentalPropertyByRange", + "parameters": [ + { + "name": "propertyName", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "start", + "in": "path", + "required": true, + "schema": { + "type": "number", + "format": "double" + } + }, + { + "name": "end", + "in": "path", + "required": true, + "schema": { + "type": "number", + "format": "double" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "string", + "oneOf": [ { - "api_key": [] + "$ref": "#/components/schemas/ChemicalPropertyExperimental" } - ] + ] + } + } } + } }, - "/chemical/file/image/search/by-dtxsid/{dtxsid}": { - "get": { - "tags": [ - "Chemical File Resource" - ], - "summary": "Get structure image by DTXSID", - "description": "return structure image for given DTXSID", - "operationId": "imageByDtxsid", - "parameters": [ - { - "name": "dtxsid", - "in": "path", - "description": "DSSTox Substance Identifier", - "required": true, - "schema": { - "type": "string" - }, - "example": "DTXSID7020182" - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "image/png": {} - } - } - }, - "security": [ + "security": [ + { + "api_key": [] + } + ] + } + }, + "/chemical/property/experimental/search/by-dtxsid/{dtxsid}": { + "get": { + "tags": [ + "Chemical Property Resource" + ], + "summary": "Get experimental properties by DTXSID", + "description": "return experimental properties for given DTXSID", + "operationId": "experimentalPropertyByDtxsid", + "parameters": [ + { + "name": "dtxsid", + "in": "path", + "description": "DSSTox Substance Identifier", + "required": true, + "schema": { + "type": "string" + }, + "example": "DTXSID7020182" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "string", + "oneOf": [ { - "api_key": [] + "$ref": "#/components/schemas/ChemicalPropertyExperimental" } - ] + ] + } + } } + } }, - "/chemical/file/image/search/by-dtxcid/{dtxcid}": { - "get": { - "tags": [ - "Chemical File Resource" - ], - "summary": "Get structure image by DTXCID", - "description": "return structure image for given DTXSID", - "operationId": "imageByDtxcid", - "parameters": [ - { - "name": "dtxcid", - "in": "path", - "description": "DSSTox Compound Identifier", - "required": true, - "schema": { - "type": "string" - }, - "example": "DTXCID505" - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "image/png": {} - } - } - }, - "security": [ + "security": [ + { + "api_key": [] + } + ] + } + }, + "/chemical/property/experimental/name": { + "get": { + "tags": [ + "Chemical Property Resource" + ], + "summary": "Get all experimental property options", + "operationId": "experimentalPropertyNames", + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "string", + "oneOf": [ { - "api_key": [] + "$ref": "#/components/schemas/ChemicalPropertyName" } - ] + ] + } + } } + } }, - "/chemical/fate/summary/search/by-dtxsid/{dtxsid}": { - "get": { - "tags": [ - "Chemical Property Resource" - ], - "summary": "Get fate summary by DTXSID", - "description": "return environmental fate and transport summary data for given DTXSID.", - "operationId": "fateSummaryByDtxsid", - "parameters": [ - { - "name": "dtxsid", - "in": "path", - "description": "DSSTox Substance Identifier", - "required": true, - "schema": { - "type": "string" - }, - "example": "DTXSID7020182" - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "string", - "oneOf": [ - { - "$ref": "#/components/schemas/ChemicalPropertySummary" - } - ] - } - } - } - } - }, - "security": [ - { - "api_key": [] - } - ] + "security": [ + { + "api_key": [] + } + ] + } + }, + "/chemical/opsin/to-smiles/{name}": { + "get": { + "tags": [ + "OPSIN Resource" + ], + "summary": "Get SMILES by name", + "description": "return SMILES for given Systematic IUPAC Name.", + "operationId": "toSmiles", + "parameters": [ + { + "name": "name", + "in": "path", + "description": "Systematic IUPAC Name", + "required": true, + "schema": { + "type": "string" + }, + "example": "acetamide" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "examples": { + "SMILES String": { + "description": "SMILES String", + "value": "C(C)(=O)N" + } + } + } } + } }, - "/chemical/fate/summary/search/": { - "get": { - "tags": [ - "Chemical Property Resource" - ], - "summary": "Get fate summary by DTXSID and property", - "description": "return environmental fate and transport data for given DTXSID and property", - "operationId": "fateSummaryByDtxsidAndName", - "parameters": [ - { - "name": "dtxsid", - "in": "query", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "propName", - "in": "query", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "string", - "oneOf": [ - { - "$ref": "#/components/schemas/ChemicalPropertySummary" - } - ] - } - } - } - } - }, - "security": [ - { - "api_key": [] - } - ] + "security": [ + { + "api_key": [] + } + ] + } + }, + "/chemical/opsin/to-inchikey/{name}": { + "get": { + "tags": [ + "OPSIN Resource" + ], + "summary": "Get InChIKey by name", + "description": "return InChIKey for given Systematic IUPAC Name.", + "operationId": "toInChIKey", + "parameters": [ + { + "name": "name", + "in": "path", + "description": "Systematic IUPAC Name", + "required": true, + "schema": { + "type": "string" + }, + "example": "acetamide" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "examples": { + "InChIKey": { + "description": "InChIKey", + "value": "DLFVBJFMPXGRIB-UHFFFAOYSA-N" + } + } + } } + } }, - "/chemical/fate/summary/predicted/search/": { - "get": { - "tags": [ - "Chemical Property Resource" - ], - "summary": "Get predicted fate summary by DTXSID and property", - "description": "return predicted environmental fate and transport data for given DTXSID and property", - "operationId": "fateSummaryPredictedByDtxsidAndName", - "parameters": [ - { - "name": "dtxsid", - "in": "query", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "propName", - "in": "query", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "string", - "oneOf": [ - { - "$ref": "#/components/schemas/ChemicalPropertySummaryExperimental" - } - ] - } - } - } - } - }, - "security": [ - { - "api_key": [] - } - ] + "security": [ + { + "api_key": [] + } + ] + } + }, + "/chemical/opsin/to-inchi/{name}": { + "get": { + "tags": [ + "OPSIN Resource" + ], + "summary": "Get InChI by name", + "description": "return InChI for given Systematic IUPAC Name.", + "operationId": "toInChI", + "parameters": [ + { + "name": "name", + "in": "path", + "description": "Systematic IUPAC Name", + "required": true, + "schema": { + "type": "string" + }, + "example": "acetamide" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "examples": { + "InChI": { + "description": "InChI", + "value": "InChI=1/C2H5NO/c1-2(3)4/h1H3,(H2,3,4)/f/h3H2" + } + } + } } + } }, - "/chemical/fate/summary/experimental/search/": { - "get": { - "tags": [ - "Chemical Property Resource" - ], - "summary": "Get experimental fate summary by DTXSID and property", - "description": "return experimental environmental fate and transport data for given DTXSID and property", - "operationId": "fateSummaryExperimentalByDtxsidAndName", - "parameters": [ - { - "name": "dtxsid", - "in": "query", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "propName", - "in": "query", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "string", - "oneOf": [ - { - "$ref": "#/components/schemas/ChemicalPropertySummaryExperimental" - } - ] - } - } - } - } - }, - "security": [ - { - "api_key": [] - } - ] + "security": [ + { + "api_key": [] + } + ] + } + }, + "/chemical/msready/search/by-mass/{start}/{end}": { + "get": { + "tags": [ + "Chemical Search Resource" + ], + "summary": "Get MS-ready chemicals using mass range", + "operationId": "msReadyByMass", + "parameters": [ + { + "name": "start", + "in": "path", + "description": "Starting mass value", + "required": true, + "schema": { + "type": "number", + "format": "double" + }, + "example": 200.9 + }, + { + "name": "end", + "in": "path", + "description": "Ending mass value", + "required": true, + "schema": { + "type": "number", + "format": "double" + }, + "example": 200.95 + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + } } + } }, - "/chemical/fate/search/by-dtxsid/{dtxsid}": { - "get": { - "tags": [ - "Chemical Property Resource" - ], - "summary": "Get fate data by DTXSID", - "description": "return environmental fate and transport data for given DTXSID", - "operationId": "fateByDtxsid", - "parameters": [ - { - "name": "dtxsid", - "in": "path", - "description": "DSSTox Substance Identifier", - "required": true, - "schema": { - "type": "string" - }, - "example": "DTXSID7020182" - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "string", - "oneOf": [ - { - "$ref": "#/components/schemas/ChemicalFateAllDto" - } - ] - } - } - } - } - }, - "security": [ - { - "api_key": [] - } - ] + "security": [ + { + "api_key": [] + } + ] + } + }, + "/chemical/msready/search/by-formula/{formula}": { + "get": { + "tags": [ + "Chemical Search Resource" + ], + "summary": "Get MS-ready chemicals by formula", + "operationId": "msReadyByFormula", + "parameters": [ + { + "name": "formula", + "in": "path", + "description": "Chemical formula", + "required": true, + "schema": { + "type": "string" + }, + "example": "C16H24N2O5S" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + } } + } }, - "/chemical/extra-data/search/by-dtxsid/{dtxsid}": { - "get": { - "tags": [ - "Lit Search Data Resource" - ], - "summary": "Get data by DTXSID", - "description": "return data for given DTXSID", - "operationId": "extraDataByDtxsid", - "parameters": [ - { - "name": "dtxsid", - "in": "path", - "description": "DSSTox Substance Identifier", - "required": true, - "schema": { - "type": "string" - }, - "example": "DTXSID101296374" - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "string", - "oneOf": [ - { - "$ref": "#/components/schemas/ExtraData" - } - ] - } - } - } - }, - "400": { - "description": "Data not found.", - "content": { - "application/problem+json": { - "schema": { - "type": "string", - "oneOf": [ - { - "$ref": "#/components/schemas/ExtraData" - } - ] - }, - "example": { - "title": "Bad Request", - "status": 400, - "detail": "dtxsid with value (${application.dtxsid}) not found.", - "instance": [ - "/chemical/extra-data/search/by-dtxsid/($application.dtxsid})" - ] - } - } - } - } - }, - "security": [ - { - "api_key": [] - } - ] + "security": [ + { + "api_key": [] + } + ] + } + }, + "/chemical/msready/search/by-dtxcid/{dtxcid}": { + "get": { + "tags": [ + "Chemical Search Resource" + ], + "summary": "Get MS-ready chemicals by DTXCID", + "operationId": "msReadyByDtxcid", + "parameters": [ + { + "name": "dtxcid", + "in": "path", + "description": "DSSTox Compound Identifier", + "required": true, + "schema": { + "type": "string" + }, + "example": "DTXCID30182" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + } } + } }, - "/chemical/detail/search/by-smiles/": { - "get": { - "tags": [ - "Chemical Details Resource" - ], - "summary": "Get data by SMILES", - "description": "return chemical details for given SMILES. Available projection is Compact.", - "operationId": "detailBySmiles", - "parameters": [ - { - "name": "smiles", - "in": "query", - "description": "SMILES String", - "required": true, - "schema": { - "type": "string" - }, - "example": "CC(C)(C1=CC=C(O)C=C1)C1=CC=C(O)C=C1" - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "string", - "oneOf": [ - { - "$ref": "#/components/schemas/compact" - } - ] - } - } - } - } - }, - "security": [ - { - "api_key": [] - } - ] + "security": [ + { + "api_key": [] + } + ] + } + }, + "/chemical/list/type": { + "get": { + "tags": [ + "Chemical List Resource" + ], + "summary": "Get all list types", + "operationId": "getAllType", + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + } } + } }, - "/chemical/detail/search/by-dtxsid/{dtxsid}": { - "get": { - "tags": [ - "Chemical Details Resource" - ], - "summary": "Get data by DTXSID", - "description": "return chemical details for given DTXSID. Optionally, user can specify a projection (set of attributes) to return.", - "operationId": "detailByDtxsid", - "parameters": [ + "security": [ + { + "api_key": [] + } + ] + } + }, + "/chemical/list/search/by-type/{type}": { + "get": { + "tags": [ + "Chemical List Resource" + ], + "summary": "Get lists by list type", + "operationId": "listByType", + "parameters": [ + { + "name": "type", + "in": "path", + "description": "Chemical List Type", + "required": true, + "schema": { + "type": "string" + }, + "example": "other" + }, + { + "name": "projection", + "in": "query", + "required": false, + "schema": { + "$ref": "#/components/schemas/ChemicalListProjection", + "default": "chemicallistall" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "string", + "oneOf": [ { - "name": "dtxsid", - "in": "path", - "description": "DSSTox Substance Identifier", - "required": true, - "schema": { - "type": "string" - }, - "example": "DTXSID7020182" + "$ref": "#/components/schemas/ChemicalList" }, { - "name": "projection", - "in": "query", - "required": false, - "schema": { - "$ref": "#/components/schemas/ChemicalDetailProjection", - "default": "chemicaldetailall" - } + "$ref": "#/components/schemas/ChemicalListName" } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "string", - "oneOf": [ - { - "$ref": "#/components/schemas/ChemicalDetailStandard" - }, - { - "$ref": "#/components/schemas/ChemicalIdentifier" - }, - { - "$ref": "#/components/schemas/ChemicalStructure" - } - ] - } - } - } - } - }, - "security": [ - { - "api_key": [] - } - ] + ] + } + } } + } }, - "/chemical/detail/search/by-dtxcid/{dtxcid}": { - "get": { - "tags": [ - "Chemical Details Resource" - ], - "summary": "Get data by DTXCID", - "description": "return chemical details for given DTXCID. Optionally, user can specify a projection (set of attributes) to return.", - "operationId": "detailsByDtxcid", - "parameters": [ + "security": [ + { + "api_key": [] + } + ] + } + }, + "/chemical/list/search/by-name/{listName}": { + "get": { + "tags": [ + "Chemical List Resource" + ], + "summary": "Get lists by name", + "operationId": "listByName", + "parameters": [ + { + "name": "listName", + "in": "path", + "description": "Chemical List Name", + "required": true, + "schema": { + "type": "string" + }, + "example": "40CFR1164" + }, + { + "name": "projection", + "in": "query", + "required": false, + "schema": { + "$ref": "#/components/schemas/ChemicalListProjection", + "default": "chemicallistall" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "string", + "oneOf": [ { - "name": "dtxcid", - "in": "path", - "description": "DSSTox Compound Identifier", - "required": true, - "schema": { - "type": "string" - }, - "example": "DTXCID505" + "$ref": "#/components/schemas/ChemicalList" }, { - "name": "projection", - "in": "query", - "required": false, - "schema": { - "$ref": "#/components/schemas/ChemicalDetailProjection", - "default": "chemicaldetailall" - } + "$ref": "#/components/schemas/ChemicalListWithDtxsids" } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "string", - "oneOf": [ - { - "$ref": "#/components/schemas/ChemicalDetailStandard" - }, - { - "$ref": "#/components/schemas/ChemicalIdentifier" - }, - { - "$ref": "#/components/schemas/ChemicalStructure" - }, - { - "$ref": "#/components/schemas/chemicaldetailall" - }, - { - "$ref": "#/components/schemas/NtaToolkit" - } - ] - } - } - } - } - }, - "security": [ - { - "api_key": [] - } - ] + ] + } + } } + } }, - "/chemical/count/by-msready-formula/{formula}": { - "get": { - "tags": [ - "Chemical Search Resource" - ], - "summary": "Get chemical count by MS-ready formula", - "operationId": "getChemicalsCountForMsreadyFormula", - "parameters": [ + "security": [ + { + "api_key": [] + } + ] + } + }, + "/chemical/list/search/by-dtxsid/{dtxsid}": { + "get": { + "tags": [ + "Chemical List Resource" + ], + "summary": "Get lists containing DTXSID", + "operationId": "listByDtxsid", + "parameters": [ + { + "name": "dtxsid", + "in": "path", + "description": "DSSTox Substance Identifier", + "required": true, + "schema": { + "type": "string" + }, + "example": "DTXSID1020560" + }, + { + "name": "projection", + "in": "query", + "required": false, + "schema": { + "$ref": "#/components/schemas/ChemicalListProjection", + "default": "chemicallistall" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "string", + "oneOf": [ { - "name": "formula", - "in": "path", - "description": "Chemical formula", - "required": true, - "schema": { - "type": "string" - }, - "example": "C15H16O2" + "$ref": "#/components/schemas/ChemicalList" }, { - "name": "projection", - "in": "query", - "required": false, - "schema": { - "type": "string", - "default": "count" - } + "$ref": "#/components/schemas/ChemicalListName" } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/hal+json": { - "schema": { - "type": "integer", - "format": "int64" - } - } - } - } - }, - "security": [ - { - "api_key": [] - } - ] + ] + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/chemical/list/chemicals/search/start-with/{list}/{word}": { + "get": { + "tags": [ + "Chemical List Resource" + ], + "summary": "Get DTXSIDs for list and containing starting string in chemical name", + "operationId": "startWith", + "parameters": [ + { + "name": "list", + "in": "path", + "description": "List Name", + "required": true, + "schema": { + "type": "string" + }, + "example": "40CFR1164" + }, + { + "name": "word", + "in": "path", + "description": "Chemical Name", + "required": true, + "schema": { + "type": "string" + }, + "example": "ammo" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/chemical/list/chemicals/search/equal/{list}/{word}": { + "get": { + "tags": [ + "Chemical List Resource" + ], + "summary": "Get DTXSIDs for list and containing exact string in chemical name", + "operationId": "exact", + "parameters": [ + { + "name": "list", + "in": "path", + "description": "List Name", + "required": true, + "schema": { + "type": "string" + }, + "example": "ANTMIC" + }, + { + "name": "word", + "in": "path", + "description": "Chemical Name", + "required": true, + "schema": { + "type": "string" + }, + "example": "PHOSPHORIC ACID" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/chemical/list/chemicals/search/contain/{list}/{word}": { + "get": { + "tags": [ + "Chemical List Resource" + ], + "summary": "Get DTXSIDs for list and containing substring in chemical name", + "operationId": "contain", + "parameters": [ + { + "name": "list", + "in": "path", + "description": "List Name", + "required": true, + "schema": { + "type": "string" + }, + "example": "ANTMIC" + }, + { + "name": "word", + "in": "path", + "description": "Chemical Name", + "required": true, + "schema": { + "type": "string" + }, + "example": "PHOSPHORIC ACID" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/chemical/list/chemicals/search/by-listname/{list}": { + "get": { + "tags": [ + "Chemical List Resource" + ], + "summary": "Get DTXSIDs by list", + "operationId": "listDtxsids", + "parameters": [ + { + "name": "list", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + } } + } }, - "/chemical/count/by-exact-formula/{formula}": { - "get": { - "tags": [ - "Chemical Search Resource" - ], - "summary": "Get chemical count by exact formula", - "operationId": "getChemicalsCountForExactFormula", - "parameters": [ + "security": [ + { + "api_key": [] + } + ] + } + }, + "/chemical/list/all": { + "get": { + "tags": [ + "Chemical List Resource" + ], + "summary": "Get all lists", + "operationId": "listAll", + "parameters": [ + { + "name": "projection", + "in": "query", + "required": false, + "schema": { + "$ref": "#/components/schemas/ChemicalListProjection", + "default": "chemicallistall" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "string", + "oneOf": [ { - "name": "formula", - "in": "path", - "description": "Chemical formula", - "required": true, - "schema": { - "type": "string" - }, - "example": "C15H16O2" + "$ref": "#/components/schemas/ChemicalList" }, { - "name": "projection", - "in": "query", - "required": false, - "schema": { - "type": "string", - "default": "count" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/hal+json": { - "schema": { - "type": "integer", - "format": "int64" - } - } - } - } - }, - "security": [ - { - "api_key": [] + "$ref": "#/components/schemas/ChemicalListName" } - ] + ] + } + } } - } + } + }, + "security": [ + { + "api_key": [] + } + ] + } }, - "components": { - "schemas": { - "ChemicalSynonymAll": { - "type": "object", - "description": "Different types of synonyms for request dtxsid", - "properties": { - "dtxsid": { - "type": "string" - }, - "valid": { - "type": "array", - "items": { - "type": "string" - } - }, - "good": { - "type": "array", - "items": { - "type": "string" - } - }, - "other": { - "type": "array", - "items": { - "type": "string" - } - }, - "deleted": { - "type": "array", - "items": { - "type": "string" - } - }, - "beilstein": { - "type": "array", - "items": { - "type": "string" - } - }, - "alternate": { - "type": "array", - "items": { - "type": "string" - } - }, - "pcCode": { - "type": "array", - "items": { - "type": "string" - } - } - } + "/chemical/ghslink/to-dtxsid/{dtxsid}": { + "get": { + "tags": [ + "PubChem to GHS Classification Resource" + ], + "summary": "Check for link by DTXSID", + "description": "This endpoint will return Y if Pubchem has GHS Safety data, otherwise N.", + "operationId": "byDtxsid_1", + "parameters": [ + { + "name": "dtxsid", + "in": "path", + "description": "DSSTox Substance Identifier", + "required": true, + "schema": { + "type": "string" }, - "ChemicalBatchSearchResult": { - "type": "object", - "properties": { - "dtxsid": { - "type": "string", - "maxLength": 20, - "minLength": 0 - }, - "dtxcid": { - "type": "string", - "maxLength": 20, - "minLength": 0 - }, - "casrn": { - "type": "string", - "maxLength": 255, - "minLength": 0 - }, - "smiles": { - "type": "string" - }, - "preferredName": { - "type": "string", - "maxLength": 255, - "minLength": 0 - }, - "searchName": { - "type": "string", - "maxLength": 50, - "minLength": 0 - }, - "searchValue": { - "type": "string" - }, - "rank": { - "type": "integer", - "format": "int32" - }, - "hasStructureImage": { - "type": "integer", - "format": "int32" - }, - "isMarkush": { - "type": "boolean" - }, - "searchMsgs": { - "type": "array", - "description": "Message about the search", - "items": { - "type": "string" - } - }, - "suggestions": { - "type": "array", - "description": "List of suggestions in case there is no match found", - "items": { - "type": "string" - } - }, - "isDuplicate": { - "type": "boolean" - } + "example": "DTXSID7020182" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GhsLinkResponse" } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/chemical/file/mrv/search/by-dtxsid/{dtxsid}": { + "get": { + "tags": [ + "Chemical File Resource" + ], + "summary": "Get mrv file by DTXSID", + "description": "return mrv file for given DTXSID", + "operationId": "mrvByDtxsid", + "parameters": [ + { + "name": "dtxsid", + "in": "path", + "description": "DSSTox Substance Identifier", + "required": true, + "schema": { + "type": "string" }, - "ChemicalPropertyPredicted": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "dtxsid": { - "type": "string", - "maxLength": 255, - "minLength": 0 - }, - "dtxcid": { - "type": "string", - "maxLength": 255, - "minLength": 0 - }, - "smiles": { - "type": "string", - "maxLength": 2000, - "minLength": 0 - }, - "canonQsarSmiles": { - "type": "string", - "maxLength": 1000, - "minLength": 0 - }, - "genericSubstanceUpdatedAt": { - "type": "string", - "format": "date-time" - }, - "propName": { - "type": "string", - "maxLength": 255, - "minLength": 0 - }, - "propCategory": { - "type": "string", - "maxLength": 255, - "minLength": 0 - }, - "propDescription": { - "type": "string", - "maxLength": 255, - "minLength": 0 - }, - "modelName": { - "type": "string", - "maxLength": 255, - "minLength": 0 - }, - "modelId": { - "type": "integer", - "format": "int64" - }, - "sourceName": { - "type": "string", - "maxLength": 255, - "minLength": 0 - }, - "sourceDescription": { - "type": "string", - "maxLength": 1000, - "minLength": 0 - }, - "propValueExperimental": { - "type": "number", - "format": "double" - }, - "propValueExperimentalString": { - "type": "string", - "maxLength": 255, - "minLength": 0 - }, - "propValue": { - "type": "number", - "format": "double" - }, - "propUnit": { - "type": "string" - }, - "propValueString": { - "type": "string", - "maxLength": 255, - "minLength": 0 - }, - "propValueError": { - "type": "string", - "maxLength": 255, - "minLength": 0 - }, - "adMethod": { - "type": "string", - "maxLength": 255, - "minLength": 0 - }, - "adValue": { - "type": "number", - "format": "double" - }, - "adConclusion": { - "type": "string", - "maxLength": 255, - "minLength": 0 - }, - "adReasoning": { - "type": "string", - "maxLength": 255, - "minLength": 0 - }, - "adMethodGlobal": { - "type": "string" - }, - "adValueGlobal": { - "type": "number", - "format": "double" - }, - "adConclusionGlobal": { - "type": "string", - "maxLength": 255, - "minLength": 0 - }, - "adReasoningGlobal": { - "type": "string", - "maxLength": 255, - "minLength": 0 - }, - "hasQmrf": { - "type": "boolean" - }, - "qmrfUrl": { - "type": "string" - } - }, - "required": [ - "id" - ] - }, - "ProblemDetail": { - "type": "object", - "properties": { - "type": { - "type": "string", - "format": "uri" - }, - "title": { - "type": "string" - }, - "status": { - "type": "integer", - "format": "int32" - }, - "detail": { - "type": "string" - }, - "instance": { - "type": "string", - "format": "uri" - }, - "properties": { - "type": "object", - "additionalProperties": {} - } - } - }, - "ChemicalPropertyExperimental": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "dtxsid": { - "type": "string", - "maxLength": 255, - "minLength": 0 - }, - "dtxcid": { - "type": "string", - "maxLength": 255, - "minLength": 0 - }, - "smiles": { - "type": "string", - "maxLength": 1000, - "minLength": 0 - }, - "propName": { - "type": "string", - "maxLength": 255, - "minLength": 0 - }, - "dataset": { - "type": "string", - "maxLength": 255, - "minLength": 0 - }, - "propValue": { - "type": "number", - "format": "double", - "maximum": 255, - "minimum": 0 - }, - "propUnit": { - "type": "string" - }, - "propValueId": { - "type": "integer", - "format": "int64" - }, - "propValueOriginal": { - "type": "string", - "maxLength": 1000, - "minLength": 0 - }, - "propValueText": { - "type": "string", - "maxLength": 255, - "minLength": 0 - }, - "expDetailsTemperatureC": { - "type": "number", - "format": "double" - }, - "expDetailsPressureMmhg": { - "type": "number", - "format": "double" - }, - "expDetailsPh": { - "type": "number", - "format": "double" - }, - "expDetailsResponseSite": { - "type": "string", - "maxLength": 255, - "minLength": 0 - }, - "expDetailsSpeciesLatin": { - "type": "string", - "maxLength": 255, - "minLength": 0 - }, - "expDetailsSpeciesCommon": { - "type": "string", - "maxLength": 255, - "minLength": 0 - }, - "expDetailsSpeciesSupercategory": { - "type": "string", - "maxLength": 255, - "minLength": 0 - }, - "sourceName": { - "type": "string" - }, - "sourceDescription": { - "type": "string" - }, - "publicSourceName": { - "type": "string", - "maxLength": 255, - "minLength": 0 - }, - "publicSourceDescription": { - "type": "string", - "maxLength": 1000, - "minLength": 0 - }, - "publicSourceUrl": { - "type": "string", - "maxLength": 255, - "minLength": 0 - }, - "directUrl": { - "type": "string", - "maxLength": 1000, - "minLength": 0 - }, - "lsName": { - "type": "string", - "maxLength": 1000, - "minLength": 0 - }, - "lsCitation": { - "type": "string", - "maxLength": 2000, - "minLength": 0 - }, - "lsDoi": { - "type": "string", - "maxLength": 255, - "minLength": 0 - }, - "briefCitation": { - "type": "string", - "maxLength": 100, - "minLength": 0 - }, - "publicSourceOriginalName": { - "type": "string", - "maxLength": 255, - "minLength": 0 - }, - "publicSourceOriginalDescription": { - "type": "string", - "maxLength": 1000, - "minLength": 0 - }, - "publicSourceOriginalUrl": { - "type": "string", - "maxLength": 255, - "minLength": 0 - } - }, - "required": [ - "id" - ] - }, - "BatchMsReadyMassForm": { - "type": "object", - "properties": { - "masses": { - "type": "array", - "items": { - "type": "number", - "format": "double" - }, - "minItems": 1 - }, - "error": { - "type": "integer", - "format": "int32" - } - }, - "required": [ - "error", - "masses" - ] - }, - "ChemicalFateBatchDto": { - "type": "object", - "properties": { - "dtxsid": { - "type": "string" - }, - "properties": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PropertyDto" - } - } - } + "example": "DTXSID7020182" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/chemical/file/mrv/search/by-dtxcid/{dtxcid}": { + "get": { + "tags": [ + "Chemical File Resource" + ], + "summary": "Get mrv file by DTXCID", + "description": "return mrv file for given DTXCID", + "operationId": "mrvByDtxcid", + "parameters": [ + { + "name": "dtxcid", + "in": "path", + "description": "DSSTox Compound Identifier", + "required": true, + "schema": { + "type": "string" }, - "PropertyDto": { - "type": "object", - "properties": { - "propName": { - "type": "string" - }, - "experimentalFateData": {}, - "predictedFateData": {} - } + "example": "DTXCID505" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/chemical/file/mol/search/by-dtxsid/{dtxsid}": { + "get": { + "tags": [ + "Chemical File Resource" + ], + "summary": "Get mol file by DTXSID", + "description": "return mol file for given DTXSID", + "operationId": "molByDtxsid", + "parameters": [ + { + "name": "dtxsid", + "in": "path", + "description": "DSSTox Substance Identifier", + "required": true, + "schema": { + "type": "string" }, - "ExtraData": { - "type": "object", - "properties": { - "dtxsid": { - "type": "string", - "maxLength": 45, - "minLength": 0 - }, - "dtxcid": { - "type": "integer", - "format": "int32", - "maximum": 45, - "minimum": 0 - }, - "refs": { - "type": "integer", - "format": "int32", - "maximum": 255, - "minimum": 0 - }, - "googlePatent": { - "type": "integer", - "format": "int32" - }, - "literature": { - "type": "integer", - "format": "int32" - }, - "pubmed": { - "type": "integer", - "format": "int32" - } - } + "example": "DTXSID7020182" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/chemical/file/mol/search/by-dtxcid/{dtxcid}": { + "get": { + "tags": [ + "Chemical File Resource" + ], + "summary": "Get mol file by DTXCID", + "description": "return mol file for given DTXCID", + "operationId": "molByDtxcid", + "parameters": [ + { + "name": "dtxcid", + "in": "path", + "description": "DSSTox Compound Identifier", + "required": true, + "schema": { + "type": "string" }, - "ChemicalDetailProjection": { - "type": "string", - "description": "Projection options for chemical details APIs ", - "enum": [ - "chemicaldetailstandard", - "chemicalidentifier", - "chemicalstructure", - "ntatoolkit", - "ccdchemicaldetails", - "ccdassaydetails", - "chemicaldetailall", - "compact" - ] + "example": "DTXCID505" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/chemical/file/image/search/by-gsid/{gsid}": { + "get": { + "tags": [ + "Chemical File Resource" + ], + "summary": "Get structure image by GSID", + "description": "return structure image for given GSID", + "operationId": "imageByGsid", + "parameters": [ + { + "name": "gsid", + "in": "path", + "description": "Generic Substance Id", + "required": true, + "schema": { + "type": "string" }, - "ChemicalDetailStandard": { - "type": "object", - "description": "Standard attributes available for chemical details APIs", - "properties": { - "preferredName": { - "type": "string" - }, - "isMarkush": { - "type": "boolean" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "hasStructureImage": { - "type": "integer", - "format": "int32" - }, - "monoisotopicMass": { - "type": "number", - "format": "double" - }, - "relatedStructureCount": { - "type": "integer", - "format": "int64" - }, - "wikipediaArticle": { - "type": "string" - }, - "descriptorStringTsv": { - "type": "string" - }, - "relatedSubstanceCount": { - "type": "integer", - "format": "int64" - }, - "genericSubstanceId": { - "type": "integer", - "format": "int32" - }, - "genericSubstanceid": { - "writeOnly": true - }, - "dtxcid": { - "type": "string" - }, - "casrn": { - "type": "string" - }, - "dtxsid": { - "type": "string" - }, - "smiles": { - "type": "string" - }, - "qcLevel": { - "type": "integer", - "format": "int32" - }, - "qcNotes": { - "type": "string" - }, - "isotope": { - "type": "integer", - "format": "int32" - }, - "multicomponent": { - "type": "integer", - "format": "int32" - }, - "totalAssays": { - "type": "integer", - "format": "int32" - }, - "toxcastSelect": { - "type": "string" - }, - "iupacName": { - "type": "string" - }, - "activeAssays": { - "type": "integer", - "format": "int32" - }, - "cpdataCount": { - "type": "integer", - "format": "int64" - }, - "qsarReadySmiles": { - "type": "string" - }, - "qcLevelDesc": { - "type": "string" - }, - "molFormula": { - "type": "string" - }, - "pubchemCount": { - "type": "integer", - "format": "int32" - }, - "inchikey": { - "type": "string" - }, - "msReadySmiles": { - "type": "string" - }, - "compoundId": { - "type": "integer", - "format": "int32" - }, - "pubmedCount": { - "type": "number", - "format": "double" - }, - "sourcesCount": { - "type": "integer", - "format": "int64" - }, - "pubchemCid": { - "type": "integer", - "format": "int32" - }, - "inchiString": { - "type": "string" - }, - "pprtvLink": { - "type": "string" - }, - "irisLink": { - "type": "string" - }, - "percentAssays": { - "type": "number", - "format": "double" - } - } + "example": 20182 + }, + { + "name": "Image Format", + "in": "query", + "description": "By default, .png image format is returned.", + "required": false, + "schema": { + "$ref": "#/components/schemas/ImageFormat" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/chemical/file/image/search/by-dtxsid/{dtxsid}": { + "get": { + "tags": [ + "Chemical File Resource" + ], + "summary": "Get structure image by DTXSID", + "description": "return structure image for given DTXSID", + "operationId": "imageByDtxsid", + "parameters": [ + { + "name": "dtxsid", + "in": "path", + "description": "DSSTox Substance Identifier", + "required": true, + "schema": { + "type": "string" }, - "ChemicalIdentifier": { - "type": "object", - "description": "Attributes related to chemical identification for chemical details APIs", - "properties": { - "preferredName": { - "type": "string" - }, - "dtxcid": { - "type": "string" - }, - "casrn": { - "type": "string" - }, - "dtxsid": { - "type": "string" - }, - "iupacName": { - "type": "string" - }, - "inchikey": { - "type": "string" - } - } + "example": "DTXSID7020182" + }, + { + "name": "Image Format", + "in": "query", + "description": "By default, .png image format is returned.", + "required": false, + "schema": { + "$ref": "#/components/schemas/ImageFormat" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/chemical/file/image/search/by-dtxcid/{dtxcid}": { + "get": { + "tags": [ + "Chemical File Resource" + ], + "summary": "Get structure image by DTXCID", + "description": "return structure image for given DTXSID", + "operationId": "imageByDtxcid", + "parameters": [ + { + "name": "dtxcid", + "in": "path", + "description": "DSSTox Compound Identifier", + "required": true, + "schema": { + "type": "string" }, - "ChemicalStructure": { - "type": "object", - "description": "Attributes related to chemical structure for chemical details APIs", - "properties": { - "preferredName": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "hasStructureImage": { - "type": "integer", - "format": "int32" - }, - "dtxcid": { - "type": "string" - }, - "casrn": { - "type": "string" - }, - "dtxsid": { - "type": "string" - }, - "smiles": { - "type": "string" - }, - "qsarReadySmiles": { - "type": "string" - }, - "inchikey": { - "type": "string" - }, - "msReadySmiles": { - "type": "string" - }, - "inchiString": { - "type": "string" - }, - "msreadySmiles": { - "writeOnly": true - } - } + "example": "DTXCID505" + }, + { + "name": "Image Format", + "in": "query", + "description": "By default, .png image format is returned.", + "required": false, + "schema": { + "$ref": "#/components/schemas/ImageFormat" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/chemical/file/image/generate": { + "get": { + "tags": [ + "Chemical File Resource" + ], + "summary": "Get structure image for SMILES", + "description": "return structure image for given SMILES", + "operationId": "generateImageBySmiles", + "parameters": [ + { + "name": "smiles", + "in": "query", + "description": "SMILES String", + "required": true, + "schema": { + "type": "string" }, - "CcdSynonymFlatProjection": { - "type": "object", - "properties": { - "quality": { - "type": "string" - }, - "synonym": { - "type": "string" - } - } + "example": "CC(C)(C1=CC=C(O)C=C1)C1=CC=C(O)C=C1" + }, + { + "name": "Image Format", + "in": "query", + "description": "By default, .png image format is returned.", + "required": false, + "schema": { + "$ref": "#/components/schemas/ImageFormat", + "default": "PNG" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/chemical/fate/summary/search/by-dtxsid/{dtxsid}": { + "get": { + "tags": [ + "Chemical Property Resource" + ], + "summary": "Get fate summary by DTXSID", + "description": "return environmental fate and transport summary data for given DTXSID.", + "operationId": "fateSummaryByDtxsid", + "parameters": [ + { + "name": "dtxsid", + "in": "path", + "description": "DSSTox Substance Identifier", + "required": true, + "schema": { + "type": "string" }, - "ChemicalSearchAll": { - "type": "object", - "properties": { - "searchName": { - "type": "string" - }, - "preferredName": { - "type": "string" - }, - "isMarkush": { - "type": "boolean" - }, - "hasStructureImage": { - "type": "integer", - "format": "int32" - }, - "dtxcid": { - "type": "string" - }, - "casrn": { - "type": "string" - }, - "dtxsid": { - "type": "string" - }, - "smiles": { - "type": "string" - }, - "rank": { - "type": "integer", - "format": "int32" - }, - "searchValue": { - "type": "string" + "example": "DTXSID7020182" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "string", + "oneOf": [ + { + "$ref": "#/components/schemas/ChemicalPropertySummary" } + ] } - }, - "ChemicalPropertySummary": { - "type": "object", - "properties": { - "experimentalCount": { - "type": "integer", - "format": "int32" - }, - "experimentalMedian": { - "type": "number", - "format": "float" - }, - "experimentalAverage": { - "type": "number", - "format": "float" - }, - "predictedAverage": { - "type": "number", - "format": "float" - }, - "unit": { - "type": "string" - }, - "propName": { - "type": "string" - }, - "experimentalMax": { - "type": "number", - "format": "float" - }, - "predictedMedian": { - "type": "number", - "format": "float" - }, - "predictedMax": { - "type": "number", - "format": "float" - }, - "experimentalMin": { - "type": "number", - "format": "float" - }, - "predictedMin": { - "type": "number", - "format": "float" - }, - "predictedCount": { - "type": "integer", - "format": "int32" + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/chemical/fate/summary/search/": { + "get": { + "tags": [ + "Chemical Property Resource" + ], + "summary": "Get fate summary by DTXSID and property", + "description": "return environmental fate and transport data for given DTXSID and property", + "operationId": "fateSummaryByDtxsidAndName", + "parameters": [ + { + "name": "dtxsid", + "in": "query", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "propName", + "in": "query", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "string", + "oneOf": [ + { + "$ref": "#/components/schemas/ChemicalPropertySummary" } + ] } - }, - "ChemicalPropertySummaryExperimental": { - "type": "object", - "properties": { - "sourceDescription": { - "type": "string" - }, - "sourceName": { - "type": "string" - }, - "publicSourceUrl": { - "type": "string" - }, - "directUrl": { - "type": "string" - }, - "propValue": { - "type": "number", - "format": "double" - }, - "responseSite": { - "type": "string" - }, - "availability": { - "type": "string" - }, - "showLink": { - "type": "boolean" - }, - "speciesLatin": { - "type": "string" + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/chemical/fate/summary/predicted/search/": { + "get": { + "tags": [ + "Chemical Property Resource" + ], + "summary": "Get predicted fate summary by DTXSID and property", + "description": "return predicted environmental fate and transport data for given DTXSID and property", + "operationId": "fateSummaryPredictedByDtxsidAndName", + "parameters": [ + { + "name": "dtxsid", + "in": "query", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "propName", + "in": "query", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "string", + "oneOf": [ + { + "$ref": "#/components/schemas/ChemicalPropertySummaryExperimental" } + ] } - }, - "ChemicalPropertyName": { - "type": "object", - "description": "Attributes for chemical property names for chemical property APIs", - "properties": { - "propertyName": { - "type": "string" + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/chemical/fate/summary/experimental/search/": { + "get": { + "tags": [ + "Chemical Property Resource" + ], + "summary": "Get experimental fate summary by DTXSID and property", + "description": "return experimental environmental fate and transport data for given DTXSID and property", + "operationId": "fateSummaryExperimentalByDtxsidAndName", + "parameters": [ + { + "name": "dtxsid", + "in": "query", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "propName", + "in": "query", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "string", + "oneOf": [ + { + "$ref": "#/components/schemas/ChemicalPropertySummaryExperimental" } + ] } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/chemical/fate/search/by-dtxsid/{dtxsid}": { + "get": { + "tags": [ + "Chemical Property Resource" + ], + "summary": "Get fate data by DTXSID", + "description": "return environmental fate and transport data for given DTXSID", + "operationId": "fateByDtxsid", + "parameters": [ + { + "name": "dtxsid", + "in": "path", + "description": "DSSTox Substance Identifier", + "required": true, + "schema": { + "type": "string" }, - "ChemicalListProjection": { - "type": "string", - "description": "Projection options for chemical List APIs ", - "enum": [ - "chemicallistall", - "chemicallistwithdtxsids", - "chemicallistname", - "ccdchemicaldetaillists" - ] - }, - "ChemicalList": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int32" - }, - "listName": { - "type": "string", - "maxLength": 50, - "minLength": 0 - }, - "label": { - "type": "string", - "maxLength": 50, - "minLength": 0 - }, - "type": { - "type": "string", - "maxLength": 50, - "minLength": 0 - }, - "shortDescription": { - "type": "string", - "maxLength": 500, - "minLength": 0 - }, - "longDescription": { - "type": "string" - }, - "chemicalCount": { - "type": "integer", - "format": "int64" - }, - "updatedAt": { - "type": "string", - "format": "date-time" + "example": "DTXSID7020182" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "string", + "oneOf": [ + { + "$ref": "#/components/schemas/ChemicalFateAllDto" } + ] } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/chemical/extra-data/search/by-dtxsid/{dtxsid}": { + "get": { + "tags": [ + "Lit Search Data Resource" + ], + "summary": "Get data by DTXSID", + "description": "return data for given DTXSID", + "operationId": "extraDataByDtxsid", + "parameters": [ + { + "name": "dtxsid", + "in": "path", + "description": "DSSTox Substance Identifier", + "required": true, + "schema": { + "type": "string" }, - "ChemicalListName": { - "type": "object", - "properties": { - "listName": { - "type": "string" + "example": "DTXSID101296374" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "string", + "oneOf": [ + { + "$ref": "#/components/schemas/ExtraData" } + ] } - }, - "ChemicalListWithDtxsids": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int32" - }, - "listName": { - "type": "string" - }, - "label": { - "type": "string" - }, - "type": { - "type": "string" - }, - "shortDescription": { - "type": "string" - }, - "longDescription": { - "type": "string" - }, - "chemicalCount": { - "type": "integer", - "format": "int64" - }, - "updatedAt": { - "type": "string", - "format": "date-time" - }, - "dtxsids": { - "type": "string" + } + } + }, + "400": { + "description": "Data not found.", + "content": { + "application/problem+json": { + "schema": { + "type": "string", + "oneOf": [ + { + "$ref": "#/components/schemas/ExtraData" } + ] + }, + "example": { + "title": "Bad Request", + "status": 400, + "detail": "dtxsid with value (${application.dtxsid}) not found.", + "instance": [ + "/chemical/extra-data/search/by-dtxsid/($application.dtxsid})" + ] } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/chemical/detail/search/by-smiles/": { + "get": { + "tags": [ + "Chemical Details Resource" + ], + "summary": "Get data by SMILES", + "description": "return chemical details for given SMILES. Available projection is Compact.", + "operationId": "detailBySmiles", + "parameters": [ + { + "name": "smiles", + "in": "query", + "description": "SMILES String", + "required": true, + "schema": { + "type": "string" }, - "ImageFormat": { - "type": "string", - "enum": [ - "PNG", - "SVG" - ] - }, - "ChemicalFateAllDto": { - "type": "object", - "properties": { - "propName": { - "type": "string" - }, - "experimentalFateData": { - "$ref": "#/components/schemas/JsonNode" - }, - "predictedFateData": { - "$ref": "#/components/schemas/JsonNode" + "example": "CC(C)(C1=CC=C(O)C=C1)C1=CC=C(O)C=C1" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "string", + "oneOf": [ + { + "$ref": "#/components/schemas/compact" } + ] } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/chemical/detail/search/by-dtxsid/{dtxsid}": { + "get": { + "tags": [ + "Chemical Details Resource" + ], + "summary": "Get data by DTXSID", + "description": "return chemical details for given DTXSID. Optionally, user can specify a projection (set of attributes) to return.", + "operationId": "detailByDtxsid", + "parameters": [ + { + "name": "dtxsid", + "in": "path", + "description": "DSSTox Substance Identifier", + "required": true, + "schema": { + "type": "string" }, - "JsonNode": {}, - "compact": { - "type": "object", - "description": "Minimum attributes for chemical details APIs", - "properties": { - "preferredName": { - "type": "string" + "example": "DTXSID7020182" + }, + { + "name": "projection", + "in": "query", + "required": false, + "schema": { + "$ref": "#/components/schemas/ChemicalDetailProjection", + "default": "chemicaldetailall" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "string", + "oneOf": [ + { + "$ref": "#/components/schemas/ChemicalDetailStandard" }, - "casrn": { - "type": "string" + { + "$ref": "#/components/schemas/ChemicalIdentifier" }, - "dtxsid": { - "type": "string" + { + "$ref": "#/components/schemas/ChemicalStructure" } + ] } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/chemical/detail/search/by-dtxcid/{dtxcid}": { + "get": { + "tags": [ + "Chemical Details Resource" + ], + "summary": "Get data by DTXCID", + "description": "return chemical details for given DTXCID. Optionally, user can specify a projection (set of attributes) to return.", + "operationId": "detailsByDtxcid", + "parameters": [ + { + "name": "dtxcid", + "in": "path", + "description": "DSSTox Compound Identifier", + "required": true, + "schema": { + "type": "string" }, - "chemicaldetailall": { - "type": "object", - "description": "All attributes available for chemical details APIs", - "properties": { - "preferredName": { - "type": "string" - }, - "isMarkush": { - "type": "boolean" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "atmosphericHydroxylationRate": { - "type": "number", - "format": "double" - }, - "meltingPointDegcOperaPred": { - "type": "number", - "format": "double" - }, - "boilingPointDegcTestPred": { - "type": "number", - "format": "double" - }, - "bioconcentrationFactorOperaPred": { - "type": "number", - "format": "double" - }, - "boilingPointDegcOperaPred": { - "type": "number", - "format": "double" - }, - "amesMutagenicityTestPred": { - "type": "number", - "format": "double" - }, - "octanolAirPartitionCoeff": { - "type": "number", - "format": "double" - }, - "biodegradationHalfLifeDays": { - "type": "number", - "format": "double" - }, - "hasStructureImage": { - "type": "integer", - "format": "int32" - }, - "monoisotopicMass": { - "type": "number", - "format": "double" - }, - "relatedStructureCount": { - "type": "integer", - "format": "int64" - }, - "flashPointDegcTestPred": { - "type": "number", - "format": "double" - }, - "wikipediaArticle": { - "type": "string" - }, - "thermalConductivity": { - "type": "number", - "format": "double" - }, - "octanolWaterPartition": { - "type": "number", - "format": "double" - }, - "viscosityCpCpTestPred": { - "type": "number", - "format": "double" - }, - "waterSolubilityTest": { - "type": "number", - "format": "double" - }, - "tetrahymenaPyriformis": { - "type": "number", - "format": "double" - }, - "descriptorStringTsv": { - "type": "string" - }, - "operaKmDaysOperaPred": { - "type": "number", - "format": "double" - }, - "relatedSubstanceCount": { - "type": "integer", - "format": "int64" - }, - "expocatMedianPrediction": { - "type": "string" - }, - "genericSubstanceId": { - "type": "integer", - "format": "int32" - }, - "waterSolubilityOpera": { - "type": "number", - "format": "double" - }, - "operaKmDayOperaPred": { - "writeOnly": true - }, - "octanolWaterpartition": { - "writeOnly": true - }, - "viscosityCpCptestPred": { - "writeOnly": true - }, - "dtxcid": { - "type": "string" - }, - "casrn": { - "type": "string" - }, - "dtxsid": { - "type": "string" - }, - "smiles": { - "type": "string" - }, - "stereo": { - "type": "string" - }, - "qcLevel": { - "type": "integer", - "format": "int32" - }, - "qcNotes": { - "type": "string" - }, - "isotope": { - "type": "integer", - "format": "int32" - }, - "nhanes": { - "type": "string" - }, - "density": { - "type": "number", - "format": "double" - }, - "expocat": { - "type": "string" - }, - "vaporPressureMmhgOperaPred": { - "type": "number", - "format": "double" - }, - "soilAdsorptionCoefficient": { - "type": "number", - "format": "double" - }, - "meltingPointDegcTestPred": { - "type": "number", - "format": "double" - }, - "vaporPressureMmhgTestPred": { - "type": "number", - "format": "double" - }, - "bioconcentrationFactorTestPred": { - "type": "number", - "format": "double" - }, - "multicomponent": { - "type": "integer", - "format": "int32" - }, - "totalAssays": { - "type": "integer", - "format": "int32" - }, - "toxcastSelect": { - "type": "string" - }, - "iupacName": { - "type": "string" - }, - "activeAssays": { - "type": "integer", - "format": "int32" - }, - "cpdataCount": { - "type": "integer", - "format": "int64" - }, - "qsarReadySmiles": { - "type": "string" - }, - "qcLevelDesc": { - "type": "string" - }, - "molFormula": { - "type": "string" - }, - "oralRatLd50Mol": { - "type": "number", - "format": "double" - }, - "surfaceTension": { - "type": "number", - "format": "double" - }, - "averageMass": { - "type": "number", - "format": "double" - }, - "pubchemCount": { - "type": "integer", - "format": "int32" - }, - "inchikey": { - "type": "string" - }, - "msReadySmiles": { - "type": "string" - }, - "compoundId": { - "type": "integer", - "format": "int32" - }, - "hrFatheadMinnow": { - "type": "number", - "format": "double" - }, - "pubmedCount": { - "type": "number", - "format": "double" - }, - "sourcesCount": { - "type": "integer", - "format": "int64" - }, - "pubchemCid": { - "type": "integer", - "format": "int32" - }, - "inchiString": { - "type": "string" - }, - "pkabOperaPred": { - "type": "number", - "format": "double" - }, - "devtoxTestPred": { - "type": "number", - "format": "double" - }, - "pprtvLink": { - "type": "string" - }, - "hrDiphniaLc50": { - "type": "number", - "format": "double" - }, - "toxvalData": { - "type": "string" - }, - "irisLink": { - "type": "string" - }, - "henrysLawAtm": { - "type": "number", - "format": "double" - }, - "percentAssays": { - "type": "number", - "format": "double" - }, - "pkaaOperaPred": { - "type": "number", - "format": "double" - }, - "devtoxTestpred": { - "writeOnly": true - }, - "soilAbsorptionCoefficient": { - "writeOnly": true - }, - "biodegredationHalfLifeDays": { - "writeOnly": true + "example": "DTXCID505" + }, + { + "name": "projection", + "in": "query", + "required": false, + "schema": { + "$ref": "#/components/schemas/ChemicalDetailProjection", + "default": "chemicaldetailall" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "string", + "oneOf": [ + { + "$ref": "#/components/schemas/ChemicalDetailStandard" }, - "vaporPressuremmhgTestPred": { - "writeOnly": true + { + "$ref": "#/components/schemas/ChemicalIdentifier" }, - "meltingPointDegctestPred": { - "writeOnly": true + { + "$ref": "#/components/schemas/ChemicalStructure" }, - "vaporPresureMmhgOperaPred": { - "writeOnly": true + { + "$ref": "#/components/schemas/chemicaldetailall" }, - "biodegredationFactorTestPred": { - "writeOnly": true + { + "$ref": "#/components/schemas/NtaToolkit" } + ] } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/chemical/count/by-msready-formula/{formula}": { + "get": { + "tags": [ + "Chemical Search Resource" + ], + "summary": "Get chemical count by MS-ready formula", + "operationId": "getChemicalsCountForMsreadyFormula", + "parameters": [ + { + "name": "formula", + "in": "path", + "description": "Chemical formula", + "required": true, + "schema": { + "type": "string" }, - "NtaToolkit": { - "type": "object", - "description": "All attributes use for NTA Informatics Toolkit.", - "properties": { - "preferredName": { - "type": "string" - }, - "monoisotopicMass": { - "type": "number", - "format": "double" - }, - "expocatMedianPrediction": { - "type": "string" - }, - "dtxcid": { - "type": "string" - }, - "casrn": { - "type": "string" - }, - "dtxsid": { - "type": "string" - }, - "smiles": { - "type": "string" - }, - "nhanes": { - "type": "string" - }, - "expocat": { - "type": "string" - }, - "totalAssays": { - "type": "integer", - "format": "int32" - }, - "activeAssays": { - "type": "integer", - "format": "int32" - }, - "cpdataCount": { - "type": "integer", - "format": "int64" - }, - "molFormula": { - "type": "string" - }, - "inchikey": { - "type": "string" - }, - "msReadySmiles": { - "type": "string" - }, - "sourcesCount": { - "type": "integer", - "format": "int64" - }, - "percentAssays": { - "type": "number", - "format": "double" - }, - "cpDataCount": { - "writeOnly": true - } + "example": "C15H16O2" + }, + { + "name": "projection", + "in": "query", + "required": false, + "schema": { + "type": "string", + "default": "count" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/hal+json": { + "schema": { + "type": "integer", + "format": "int64" } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/chemical/count/by-exact-formula/{formula}": { + "get": { + "tags": [ + "Chemical Search Resource" + ], + "summary": "Get chemical count by exact formula", + "operationId": "getChemicalsCountForExactFormula", + "parameters": [ + { + "name": "formula", + "in": "path", + "description": "Chemical formula", + "required": true, + "schema": { + "type": "string" }, - "ChemicalDetailStandard2": { - "type": "object", - "properties": { - "preferredName": { - "type": "string" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "monoisotopicMass": { - "type": "number", - "format": "double" - }, - "casrn": { - "type": "string" - }, - "dtxsid": { - "type": "string" - }, - "smiles": { - "type": "string" - }, - "qcLevel": { - "type": "integer", - "format": "int32" - }, - "iupacName": { - "type": "string" - }, - "qcLevelDesc": { - "type": "string" - }, - "molFormula": { - "type": "string" - }, - "averageMass": { - "type": "number", - "format": "double" - }, - "inchikey": { - "type": "string" - }, - "inchiString": { - "type": "string" - } + "example": "C15H16O2" + }, + { + "name": "projection", + "in": "query", + "required": false, + "schema": { + "type": "string", + "default": "count" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/hal+json": { + "schema": { + "type": "integer", + "format": "int64" } - }, - "Link": { - "type": "object", - "properties": { - "href": { - "type": "string" - }, - "hreflang": { - "type": "string" - }, - "title": { - "type": "string" - }, - "type": { - "type": "string" - }, - "deprecation": { - "type": "string" - }, - "profile": { - "type": "string" - }, - "name": { - "type": "string" + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/chemical/all": { + "get": { + "tags": [ + "Chemical Details Resource" + ], + "summary": "Get all data", + "description": "return all chemical details. The next parameter allows pagination for retrieval, but retrieval is limited to batches of 1000 per request. Please consider downloading the DSSTOX database instead accessing this information via API.", + "operationId": "getAllChemicalDetails", + "parameters": [ + { + "name": "next", + "in": "query", + "required": false, + "schema": { + "type": "integer", + "format": "int64", + "default": 1 + } + }, + { + "name": "projection", + "in": "query", + "description": "Specifies if projection is used. Option: all-ids. If omitted, the default ChemicalDetailStandard2 data is returned.", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "string", + "oneOf": [ + { + "$ref": "#/components/schemas/ChemicalDetailStandard2" }, - "templated": { - "type": "boolean" + { + "$ref": "#/components/schemas/ChemicalDetailAllIds" } + ] } - }, - "Links": { - "type": "object", - "additionalProperties": { - "$ref": "#/components/schemas/Link" - } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + } + }, + "components": { + "schemas": { + "WikipediaLinkResponse": { + "type": "object", + "properties": { + "dtxsid": { + "type": "string" + }, + "safetyUrl": { + "type": "string" + } + } + }, + "ChemicalSynonymAll": { + "type": "object", + "description": "Different types of synonyms for request dtxsid", + "properties": { + "dtxsid": { + "type": "string" + }, + "valid": { + "type": "array", + "items": { + "type": "string" + } + }, + "good": { + "type": "array", + "items": { + "type": "string" + } + }, + "other": { + "type": "array", + "items": { + "type": "string" + } + }, + "deleted": { + "type": "array", + "items": { + "type": "string" + } + }, + "beilstein": { + "type": "array", + "items": { + "type": "string" + } + }, + "alternate": { + "type": "array", + "items": { + "type": "string" + } + }, + "pcCode": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "ChemicalBatchSearchResult": { + "type": "object", + "properties": { + "dtxsid": { + "type": "string", + "maxLength": 20, + "minLength": 0 + }, + "dtxcid": { + "type": "string", + "maxLength": 20, + "minLength": 0 + }, + "casrn": { + "type": "string", + "maxLength": 255, + "minLength": 0 + }, + "smiles": { + "type": "string" + }, + "preferredName": { + "type": "string", + "maxLength": 255, + "minLength": 0 + }, + "searchName": { + "type": "string", + "maxLength": 50, + "minLength": 0 + }, + "searchValue": { + "type": "string" + }, + "rank": { + "type": "integer", + "format": "int32" + }, + "hasStructureImage": { + "type": "integer", + "format": "int32" + }, + "isMarkush": { + "type": "boolean" + }, + "searchMsgs": { + "type": "array", + "description": "Message about the search", + "items": { + "type": "string" + } + }, + "suggestions": { + "type": "array", + "description": "List of suggestions in case there is no match found", + "items": { + "type": "string" + } + }, + "isDuplicate": { + "type": "boolean" + } + } + }, + "ChemicalPropertyPredicted": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "dtxsid": { + "type": "string", + "maxLength": 255, + "minLength": 0 + }, + "dtxcid": { + "type": "string", + "maxLength": 255, + "minLength": 0 + }, + "smiles": { + "type": "string", + "maxLength": 2000, + "minLength": 0 + }, + "canonQsarSmiles": { + "type": "string", + "maxLength": 1000, + "minLength": 0 + }, + "genericSubstanceUpdatedAt": { + "type": "string", + "format": "date-time" + }, + "propName": { + "type": "string", + "maxLength": 255, + "minLength": 0 + }, + "propCategory": { + "type": "string", + "maxLength": 255, + "minLength": 0 + }, + "propDescription": { + "type": "string", + "maxLength": 255, + "minLength": 0 + }, + "modelName": { + "type": "string", + "maxLength": 255, + "minLength": 0 + }, + "modelId": { + "type": "integer", + "format": "int64" + }, + "sourceName": { + "type": "string", + "maxLength": 255, + "minLength": 0 + }, + "sourceDescription": { + "type": "string", + "maxLength": 1000, + "minLength": 0 + }, + "propValueExperimental": { + "type": "number", + "format": "double" + }, + "propValueExperimentalString": { + "type": "string", + "maxLength": 255, + "minLength": 0 + }, + "propValue": { + "type": "number", + "format": "double" + }, + "propUnit": { + "type": "string" + }, + "propValueString": { + "type": "string", + "maxLength": 255, + "minLength": 0 + }, + "propValueError": { + "type": "string", + "maxLength": 255, + "minLength": 0 + }, + "adMethod": { + "type": "string", + "maxLength": 255, + "minLength": 0 + }, + "adValue": { + "type": "number", + "format": "double" + }, + "adConclusion": { + "type": "string", + "maxLength": 255, + "minLength": 0 + }, + "adReasoning": { + "type": "string", + "maxLength": 255, + "minLength": 0 + }, + "adMethodGlobal": { + "type": "string" + }, + "adValueGlobal": { + "type": "number", + "format": "double" + }, + "adConclusionGlobal": { + "type": "string", + "maxLength": 255, + "minLength": 0 + }, + "adReasoningGlobal": { + "type": "string", + "maxLength": 255, + "minLength": 0 + }, + "hasQmrf": { + "type": "boolean" + }, + "qmrfUrl": { + "type": "string" + } + }, + "required": [ + "id" + ] + }, + "ProblemDetail": { + "type": "object", + "properties": { + "type": { + "type": "string", + "format": "uri" + }, + "title": { + "type": "string" + }, + "status": { + "type": "integer", + "format": "int32" + }, + "detail": { + "type": "string" + }, + "instance": { + "type": "string", + "format": "uri" + }, + "properties": { + "type": "object", + "additionalProperties": { + } + } + } + }, + "ChemicalPropertyExperimental": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "dtxsid": { + "type": "string", + "maxLength": 255, + "minLength": 0 + }, + "dtxcid": { + "type": "string", + "maxLength": 255, + "minLength": 0 + }, + "smiles": { + "type": "string", + "maxLength": 1000, + "minLength": 0 + }, + "propName": { + "type": "string", + "maxLength": 255, + "minLength": 0 + }, + "dataset": { + "type": "string", + "maxLength": 255, + "minLength": 0 + }, + "propValue": { + "type": "number", + "format": "double", + "maximum": 255, + "minimum": 0 + }, + "propUnit": { + "type": "string" + }, + "propValueId": { + "type": "integer", + "format": "int64" + }, + "propValueOriginal": { + "type": "string", + "maxLength": 1000, + "minLength": 0 + }, + "propValueText": { + "type": "string", + "maxLength": 255, + "minLength": 0 + }, + "expDetailsTemperatureC": { + "type": "number", + "format": "double" + }, + "expDetailsPressureMmhg": { + "type": "number", + "format": "double" + }, + "expDetailsPh": { + "type": "number", + "format": "double" + }, + "expDetailsResponseSite": { + "type": "string", + "maxLength": 255, + "minLength": 0 + }, + "expDetailsSpeciesLatin": { + "type": "string", + "maxLength": 255, + "minLength": 0 + }, + "expDetailsSpeciesCommon": { + "type": "string", + "maxLength": 255, + "minLength": 0 + }, + "expDetailsSpeciesSupercategory": { + "type": "string", + "maxLength": 255, + "minLength": 0 + }, + "sourceName": { + "type": "string" + }, + "sourceDescription": { + "type": "string" + }, + "publicSourceName": { + "type": "string", + "maxLength": 255, + "minLength": 0 + }, + "publicSourceDescription": { + "type": "string", + "maxLength": 1000, + "minLength": 0 + }, + "publicSourceUrl": { + "type": "string", + "maxLength": 255, + "minLength": 0 + }, + "directUrl": { + "type": "string", + "maxLength": 1000, + "minLength": 0 + }, + "lsName": { + "type": "string", + "maxLength": 1000, + "minLength": 0 + }, + "lsCitation": { + "type": "string", + "maxLength": 2000, + "minLength": 0 + }, + "lsDoi": { + "type": "string", + "maxLength": 255, + "minLength": 0 + }, + "briefCitation": { + "type": "string", + "maxLength": 100, + "minLength": 0 + }, + "publicSourceOriginalName": { + "type": "string", + "maxLength": 255, + "minLength": 0 + }, + "publicSourceOriginalDescription": { + "type": "string", + "maxLength": 1000, + "minLength": 0 + }, + "publicSourceOriginalUrl": { + "type": "string", + "maxLength": 255, + "minLength": 0 + } + }, + "required": [ + "id" + ] + }, + "BatchMsReadyMassForm": { + "type": "object", + "properties": { + "masses": { + "type": "array", + "items": { + "type": "number", + "format": "double" + }, + "minItems": 1 + }, + "error": { + "type": "integer", + "format": "int32" + } }, - "securitySchemes": { - "api_key": { - "type": "apiKey", - "description": "Each API request requires an api_key. Contact the CTX API Admin to request an API Key.", - "name": "x-api-key", - "in": "header" + "required": [ + "error", + "masses" + ] + }, + "GhsLinkResponse": { + "type": "object", + "properties": { + "dtxsid": { + "type": "string" + }, + "isSafetyData": { + "type": "boolean" + }, + "safetyUrl": { + "type": "string" + } + } + }, + "ChemicalFateBatchDto": { + "type": "object", + "properties": { + "dtxsid": { + "type": "string" + }, + "properties": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PropertyDto" } + } + } + }, + "PropertyDto": { + "type": "object", + "properties": { + "propName": { + "type": "string" + }, + "experimentalFateData": { + + }, + "predictedFateData": { + + } + } + }, + "ExtraData": { + "type": "object", + "properties": { + "dtxsid": { + "type": "string", + "maxLength": 45, + "minLength": 0 + }, + "dtxcid": { + "type": "integer", + "format": "int32", + "maximum": 45, + "minimum": 0 + }, + "refs": { + "type": "integer", + "format": "int32", + "maximum": 255, + "minimum": 0 + }, + "googlePatent": { + "type": "integer", + "format": "int32" + }, + "literature": { + "type": "integer", + "format": "int32" + }, + "pubmed": { + "type": "integer", + "format": "int32" + } + } + }, + "ChemicalDetailProjection": { + "type": "string", + "description": "Projection options for chemical details APIs ", + "enum": [ + "chemicaldetailstandard", + "chemicalidentifier", + "chemicalstructure", + "ntatoolkit", + "ccdchemicaldetails", + "ccdassaydetails", + "chemicaldetailall", + "compact" + ] + }, + "ChemicalDetailStandard": { + "type": "object", + "description": "Standard attributes available for chemical details APIs", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "irisLink": { + "type": "string" + }, + "genericSubstanceid": { + "writeOnly": true + }, + "sourcesCount": { + "type": "integer", + "format": "int64" + }, + "qcLevel": { + "type": "integer", + "format": "int32" + }, + "casrn": { + "type": "string" + }, + "dtxcid": { + "type": "string" + }, + "preferredName": { + "type": "string" + }, + "molFormula": { + "type": "string" + }, + "percentAssays": { + "type": "number", + "format": "double" + }, + "cpdataCount": { + "type": "integer", + "format": "int64" + }, + "activeAssays": { + "type": "integer", + "format": "int32" + }, + "pubmedCount": { + "type": "number", + "format": "double" + }, + "dtxsid": { + "type": "string" + }, + "compoundId": { + "type": "integer", + "format": "int32" + }, + "pubchemCount": { + "type": "integer", + "format": "int32" + }, + "toxcastSelect": { + "type": "string" + }, + "qcLevelDesc": { + "type": "string" + }, + "inchiString": { + "type": "string" + }, + "inchikey": { + "type": "string" + }, + "pubchemCid": { + "type": "integer", + "format": "int32" + }, + "qcNotes": { + "type": "string" + }, + "smiles": { + "type": "string" + }, + "qsarReadySmiles": { + "type": "string" + }, + "iupacName": { + "type": "string" + }, + "isotope": { + "type": "integer", + "format": "int32" + }, + "multicomponent": { + "type": "integer", + "format": "int32" + }, + "totalAssays": { + "type": "integer", + "format": "int32" + }, + "isMarkush": { + "type": "boolean" + }, + "pprtvLink": { + "type": "string" + }, + "msReadySmiles": { + "type": "string" + }, + "relatedSubstanceCount": { + "type": "integer", + "format": "int64" + }, + "descriptorStringTsv": { + "type": "string" + }, + "genericSubstanceId": { + "type": "integer", + "format": "int32" + }, + "hasStructureImage": { + "type": "integer", + "format": "int32" + }, + "wikipediaArticle": { + "type": "string" + }, + "monoisotopicMass": { + "type": "number", + "format": "double" + }, + "relatedStructureCount": { + "type": "integer", + "format": "int64" + } + } + }, + "ChemicalIdentifier": { + "type": "object", + "description": "Attributes related to chemical identification for chemical details APIs", + "properties": { + "casrn": { + "type": "string" + }, + "dtxcid": { + "type": "string" + }, + "preferredName": { + "type": "string" + }, + "dtxsid": { + "type": "string" + }, + "inchikey": { + "type": "string" + }, + "iupacName": { + "type": "string" + } + } + }, + "ChemicalStructure": { + "type": "object", + "description": "Attributes related to chemical structure for chemical details APIs", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "msreadySmiles": { + "writeOnly": true + }, + "casrn": { + "type": "string" + }, + "dtxcid": { + "type": "string" + }, + "preferredName": { + "type": "string" + }, + "dtxsid": { + "type": "string" + }, + "inchiString": { + "type": "string" + }, + "inchikey": { + "type": "string" + }, + "smiles": { + "type": "string" + }, + "qsarReadySmiles": { + "type": "string" + }, + "msReadySmiles": { + "type": "string" + }, + "hasStructureImage": { + "type": "integer", + "format": "int32" + } + } + }, + "CcdSynonymFlatProjection": { + "type": "object", + "properties": { + "synonym": { + "type": "string" + }, + "quality": { + "type": "string" + } + } + }, + "ChemicalSearchAll": { + "type": "object", + "properties": { + "casrn": { + "type": "string" + }, + "dtxcid": { + "type": "string" + }, + "preferredName": { + "type": "string" + }, + "dtxsid": { + "type": "string" + }, + "smiles": { + "type": "string" + }, + "isMarkush": { + "type": "boolean" + }, + "searchName": { + "type": "string" + }, + "searchValue": { + "type": "string" + }, + "rank": { + "type": "integer", + "format": "int32" + }, + "hasStructureImage": { + "type": "integer", + "format": "int32" + } + } + }, + "ChemicalPropertySummary": { + "type": "object", + "properties": { + "experimentalCount": { + "type": "integer", + "format": "int32" + }, + "experimentalMedian": { + "type": "number", + "format": "float" + }, + "predictedAverage": { + "type": "number", + "format": "float" + }, + "experimentalAverage": { + "type": "number", + "format": "float" + }, + "experimentalMin": { + "type": "number", + "format": "float" + }, + "predictedMax": { + "type": "number", + "format": "float" + }, + "predictedCount": { + "type": "integer", + "format": "int32" + }, + "experimentalMax": { + "type": "number", + "format": "float" + }, + "predictedMedian": { + "type": "number", + "format": "float" + }, + "predictedMin": { + "type": "number", + "format": "float" + }, + "propName": { + "type": "string" + }, + "unit": { + "type": "string" + } + } + }, + "ChemicalPropertySummaryExperimental": { + "type": "object", + "properties": { + "showLink": { + "type": "boolean" + }, + "speciesLatin": { + "type": "string" + }, + "responseSite": { + "type": "string" + }, + "availability": { + "type": "string" + }, + "sourceDescription": { + "type": "string" + }, + "propValue": { + "type": "number", + "format": "double" + }, + "directUrl": { + "type": "string" + }, + "publicSourceUrl": { + "type": "string" + }, + "sourceName": { + "type": "string" + } } + }, + "ChemicalPropertyName": { + "type": "object", + "description": "Attributes for chemical property names for chemical property APIs", + "properties": { + "propertyName": { + "type": "string" + } + } + }, + "ChemicalListProjection": { + "type": "string", + "description": "Projection options for chemical List APIs ", + "enum": [ + "chemicallistall", + "chemicallistwithdtxsids", + "chemicallistname", + "ccdchemicaldetaillists" + ] + }, + "ChemicalList": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int32" + }, + "listName": { + "type": "string", + "maxLength": 50, + "minLength": 0 + }, + "label": { + "type": "string", + "maxLength": 50, + "minLength": 0 + }, + "type": { + "type": "string", + "maxLength": 50, + "minLength": 0 + }, + "shortDescription": { + "type": "string", + "maxLength": 500, + "minLength": 0 + }, + "longDescription": { + "type": "string" + }, + "chemicalCount": { + "type": "integer", + "format": "int64" + }, + "updatedAt": { + "type": "string", + "format": "date-time" + } + } + }, + "ChemicalListName": { + "type": "object", + "properties": { + "listName": { + "type": "string" + } + } + }, + "ChemicalListWithDtxsids": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int32" + }, + "listName": { + "type": "string" + }, + "label": { + "type": "string" + }, + "type": { + "type": "string" + }, + "shortDescription": { + "type": "string" + }, + "longDescription": { + "type": "string" + }, + "chemicalCount": { + "type": "integer", + "format": "int64" + }, + "updatedAt": { + "type": "string", + "format": "date-time" + }, + "dtxsids": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "ImageFormat": { + "type": "string", + "enum": [ + "PNG", + "SVG" + ] + }, + "ChemicalFateAllDto": { + "type": "object", + "properties": { + "propName": { + "type": "string" + }, + "experimentalFateData": { + "$ref": "#/components/schemas/JsonNode" + }, + "predictedFateData": { + "$ref": "#/components/schemas/JsonNode" + } + } + }, + "JsonNode": { + + }, + "compact": { + "type": "object", + "description": "Minimum attributes for chemical details APIs", + "properties": { + "casrn": { + "type": "string" + }, + "preferredName": { + "type": "string" + }, + "dtxsid": { + "type": "string" + } + } + }, + "chemicaldetailall": { + "type": "object", + "description": "All attributes available for chemical details APIs", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "viscosityCpCptestPred": { + "writeOnly": true + }, + "octanolWaterpartition": { + "writeOnly": true + }, + "meltingPointDegctestPred": { + "writeOnly": true + }, + "operaKmDayOperaPred": { + "writeOnly": true + }, + "biodegredationFactorTestPred": { + "writeOnly": true + }, + "vaporPressuremmhgTestPred": { + "writeOnly": true + }, + "biodegredationHalfLifeDays": { + "writeOnly": true + }, + "vaporPresureMmhgOperaPred": { + "writeOnly": true + }, + "soilAbsorptionCoefficient": { + "writeOnly": true + }, + "devtoxTestpred": { + "writeOnly": true + }, + "soilAdsorptionCoefficient": { + "type": "number", + "format": "double" + }, + "meltingPointDegcTestPred": { + "type": "number", + "format": "double" + }, + "meltingPointDegcOperaPred": { + "type": "number", + "format": "double" + }, + "flashPointDegcTestPred": { + "type": "number", + "format": "double" + }, + "octanolWaterPartition": { + "type": "number", + "format": "double" + }, + "operaKmDaysOperaPred": { + "type": "number", + "format": "double" + }, + "boilingPointDegcTestPred": { + "type": "number", + "format": "double" + }, + "waterSolubilityTest": { + "type": "number", + "format": "double" + }, + "vaporPressureMmhgTestPred": { + "type": "number", + "format": "double" + }, + "thermalConductivity": { + "type": "number", + "format": "double" + }, + "biodegradationHalfLifeDays": { + "type": "number", + "format": "double" + }, + "bioconcentrationFactorTestPred": { + "type": "number", + "format": "double" + }, + "bioconcentrationFactorOperaPred": { + "type": "number", + "format": "double" + }, + "atmosphericHydroxylationRate": { + "type": "number", + "format": "double" + }, + "boilingPointDegcOperaPred": { + "type": "number", + "format": "double" + }, + "tetrahymenaPyriformis": { + "type": "number", + "format": "double" + }, + "viscosityCpCpTestPred": { + "type": "number", + "format": "double" + }, + "vaporPressureMmhgOperaPred": { + "type": "number", + "format": "double" + }, + "octanolAirPartitionCoeff": { + "type": "number", + "format": "double" + }, + "expocatMedianPrediction": { + "type": "string" + }, + "waterSolubilityOpera": { + "type": "number", + "format": "double" + }, + "amesMutagenicityTestPred": { + "type": "number", + "format": "double" + }, + "sourcesCount": { + "type": "integer", + "format": "int64" + }, + "qcLevel": { + "type": "integer", + "format": "int32" + }, + "casrn": { + "type": "string" + }, + "dtxcid": { + "type": "string" + }, + "preferredName": { + "type": "string" + }, + "molFormula": { + "type": "string" + }, + "percentAssays": { + "type": "number", + "format": "double" + }, + "cpdataCount": { + "type": "integer", + "format": "int64" + }, + "activeAssays": { + "type": "integer", + "format": "int32" + }, + "pubmedCount": { + "type": "number", + "format": "double" + }, + "dtxsid": { + "type": "string" + }, + "compoundId": { + "type": "integer", + "format": "int32" + }, + "pubchemCount": { + "type": "integer", + "format": "int32" + }, + "toxcastSelect": { + "type": "string" + }, + "qcLevelDesc": { + "type": "string" + }, + "inchiString": { + "type": "string" + }, + "inchikey": { + "type": "string" + }, + "pubchemCid": { + "type": "integer", + "format": "int32" + }, + "qcNotes": { + "type": "string" + }, + "smiles": { + "type": "string" + }, + "qsarReadySmiles": { + "type": "string" + }, + "iupacName": { + "type": "string" + }, + "isotope": { + "type": "integer", + "format": "int32" + }, + "stereo": { + "type": "string" + }, + "multicomponent": { + "type": "integer", + "format": "int32" + }, + "totalAssays": { + "type": "integer", + "format": "int32" + }, + "averageMass": { + "type": "number", + "format": "double" + }, + "irisLink": { + "type": "string" + }, + "isMarkush": { + "type": "boolean" + }, + "pprtvLink": { + "type": "string" + }, + "msReadySmiles": { + "type": "string" + }, + "nhanes": { + "type": "string" + }, + "surfaceTension": { + "type": "number", + "format": "double" + }, + "oralRatLd50Mol": { + "type": "number", + "format": "double" + }, + "hrFatheadMinnow": { + "type": "number", + "format": "double" + }, + "hrDiphniaLc50": { + "type": "number", + "format": "double" + }, + "expocat": { + "type": "string" + }, + "toxvalData": { + "type": "string" + }, + "henrysLawAtm": { + "type": "number", + "format": "double" + }, + "density": { + "type": "number", + "format": "double" + }, + "pkabOperaPred": { + "type": "number", + "format": "double" + }, + "pkaaOperaPred": { + "type": "number", + "format": "double" + }, + "devtoxTestPred": { + "type": "number", + "format": "double" + }, + "relatedSubstanceCount": { + "type": "integer", + "format": "int64" + }, + "descriptorStringTsv": { + "type": "string" + }, + "genericSubstanceId": { + "type": "integer", + "format": "int32" + }, + "hasStructureImage": { + "type": "integer", + "format": "int32" + }, + "wikipediaArticle": { + "type": "string" + }, + "monoisotopicMass": { + "type": "number", + "format": "double" + }, + "relatedStructureCount": { + "type": "integer", + "format": "int64" + } + } + }, + "NtaToolkit": { + "type": "object", + "description": "All attributes use for NTA Informatics Toolkit.", + "properties": { + "cpDataCount": { + "writeOnly": true + }, + "expocatMedianPrediction": { + "type": "string" + }, + "sourcesCount": { + "type": "integer", + "format": "int64" + }, + "casrn": { + "type": "string" + }, + "dtxcid": { + "type": "string" + }, + "preferredName": { + "type": "string" + }, + "molFormula": { + "type": "string" + }, + "percentAssays": { + "type": "number", + "format": "double" + }, + "cpdataCount": { + "type": "integer", + "format": "int64" + }, + "activeAssays": { + "type": "integer", + "format": "int32" + }, + "dtxsid": { + "type": "string" + }, + "inchikey": { + "type": "string" + }, + "smiles": { + "type": "string" + }, + "totalAssays": { + "type": "integer", + "format": "int32" + }, + "msReadySmiles": { + "type": "string" + }, + "nhanes": { + "type": "string" + }, + "expocat": { + "type": "string" + }, + "monoisotopicMass": { + "type": "number", + "format": "double" + } + } + }, + "ChemicalDetailStandard2": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "qcLevel": { + "type": "integer", + "format": "int32" + }, + "casrn": { + "type": "string" + }, + "preferredName": { + "type": "string" + }, + "molFormula": { + "type": "string" + }, + "dtxsid": { + "type": "string" + }, + "qcLevelDesc": { + "type": "string" + }, + "inchiString": { + "type": "string" + }, + "inchikey": { + "type": "string" + }, + "smiles": { + "type": "string" + }, + "iupacName": { + "type": "string" + }, + "averageMass": { + "type": "number", + "format": "double" + }, + "monoisotopicMass": { + "type": "number", + "format": "double" + } + } + }, + "ChemicalDetailAllIds": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "dtxcid": { + "type": "string" + }, + "dtxsid": { + "type": "string" + } + } + }, + "Link": { + "type": "object", + "properties": { + "href": { + "type": "string" + }, + "hreflang": { + "type": "string" + }, + "title": { + "type": "string" + }, + "type": { + "type": "string" + }, + "deprecation": { + "type": "string" + }, + "profile": { + "type": "string" + }, + "name": { + "type": "string" + }, + "templated": { + "type": "boolean" + } + } + }, + "Links": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/Link" + } + } + }, + "securitySchemes": { + "api_key": { + "type": "apiKey", + "description": "Each API request requires an api_key. Contact the CTX API Admin to request an API Key.", + "name": "x-api-key", + "in": "header" + } } -} + } +} \ No newline at end of file diff --git a/public/docs/exposure.json b/public/docs/exposure.json index cca01b6..3400421 100644 --- a/public/docs/exposure.json +++ b/public/docs/exposure.json @@ -7,18 +7,26 @@ }, "servers": [ { - "url": "https://ctx-api-dev.ccte.epa.gov", - "description": "Development Environment" + "url": "https://comptox.epa.gov/ctx-api", + "description": "Production Environment" } ], "tags": [ + { + "name": "List Presence Resource", + "description": "Collection of endpoints with list presence data, reflecting the occurrence of chemicals on lists present in publicly available documents (sourced from a variety of federal and state agencies and trade associations). These lists are tagged with List Presence Keywords (LPKs) which is a controlled vocabulary developed by EPA that describe broad use information for a chemical useful for general categorization of chemicals across uses, populations, and/or regulatory groups. These curated data are sourced from US EPA's Chemicals and Products Database (CPDat)." + }, + { + "name": "CCD Data Resource", + "description": "Collection of endpoints used to populate CompTox Chemicals Dashboard (CCD) Exposure tabs." + }, { "name": "Functional Use Resource", "description": "Collection of endpoints with functional use data. Functional use describes a chemical's role in a product or process, which can help determine exposure pathways used to assess chemical exposure. These curated data are sourced from US EPA's Chemicals and Products Database (CPDat)." }, { - "name": "List Presence Resource", - "description": "Collection of endpoints with list presence data, reflecting the occurrence of chemicals on lists present in publicly available documents (sourced from a variety of federal and state agencies and trade associations). These lists are tagged with List Presence Keywords (LPKs) which is a controlled vocabulary developed by EPA that describe broad use information for a chemical useful for general categorization of chemicals across uses, populations, and/or regulatory groups. These curated data are sourced from US EPA's Chemicals and Products Database (CPDat)." + "name": "MMDB Resource", + "description": "Collection of endpoints with harmonized data from the Multimedia Monitoring Database (MMDB) to inform on chemical presence in various media like air, water, soil, and human tissues." }, { "name": "Product Data Resource", @@ -35,14 +43,6 @@ { "name": "General Exposure Prediction Resource", "description": "Collection of endpoints for general prediction data. SEEM (Systematic Empirical Evaluation of Models) is a framework developed by the US EPA to predict exposure to chemicals across the general population and demographic subsets of the US." - }, - { - "name": "MMDB Resource", - "description": "Collection of endpoints with harmonized data from the Multimedia Monitoring Database (MMDB) to inform on chemical presence in various media like air, water, soil, and human tissues." - }, - { - "name": "CCD Data Resource", - "description": "Collection of endpoints used to populate CompTox Chemicals Dashboard (CCD) Exposure tabs." } ], "paths": { @@ -2234,15 +2234,6 @@ "CCDBiomonitoringAll": { "type": "object", "properties": { - "label": { - "type": "string" - }, - "dtxsid": { - "type": "string" - }, - "median": { - "type": "number" - }, "upper95th": { "type": "number" }, @@ -2251,6 +2242,15 @@ }, "hoverMsg": { "type": "string" + }, + "label": { + "type": "string" + }, + "median": { + "type": "number" + }, + "dtxsid": { + "type": "string" } } }, @@ -2379,13 +2379,13 @@ } } }, - "securitySchemes": { - "api_key": { - "type": "apiKey", - "description": "Each API request requires an api_key. Contact the CTX API Admin to request an API Key.", - "name": "x-api-key", - "in": "header" - } - } + "securitySchemes": { + "api_key": { + "type": "apiKey", + "description": "Each API request requires an api_key. Contact the CTX API Admin to request an API Key.", + "name": "x-api-key", + "in": "header" + } } -} + } +} \ No newline at end of file diff --git a/public/docs/hazard.json b/public/docs/hazard.json index 123e46d..0b7f1b9 100644 --- a/public/docs/hazard.json +++ b/public/docs/hazard.json @@ -1,3679 +1,3380 @@ { - "openapi": "3.1.0", - "info": { - "title": "Computational Toxicology and Exposure (CTX) APIs - CTX Hazard API", - "description": "The CTX Hazard API is part of US EPA's Computational Toxicology and Exposure APIs. The CTX Hazard API provides programmtic access to hazard data through a set of endpoints.", - "version": "1.1.1" + "openapi": "3.1.0", + "info": { + "title": "Computational Toxicology and Exposure (CTX) APIs - CTX Hazard API", + "description": "The CTX Hazard API is part of US EPA's Computational Toxicology and Exposure APIs. The CTX Hazard API provides programmtic access to hazard data through a set of endpoints.", + "version": "1.1.1" + }, + "servers": [ + { + "url": "https://comptox.epa.gov/ctx-api", + "description": "Production Environment" + } + ], + "tags": [ + { + "name": "ToxValDB Resource", + "description": "Collection of endpoints for human-relevant hazard data curated in the Toxicity Values Database (ToxValDB). ToxValDB is a compilation of information sourced from multiple public datasets, databases and open literature and includes data on thousands of chemicals from tens of thousands of records, with an emphasis on quantitative estimates of relevant points-of-departure from in vivo toxicology studies, such as no- and low- observable adverse effect levels, screening levels, reference doses, tolerable daily intake, etc." }, - "servers": [ - { - "url": "https://ctx-api-dev.ccte.epa.gov", - "description": "Development Environment" - } - ], - "tags": [ - { - "name": "ToxValDB Resource", - "description": "Collection of endpoints for human-relevant hazard data curated in the Toxicity Values Database (ToxValDB). ToxValDB is a compilation of information sourced from multiple public datasets, databases and open literature and includes data on thousands of chemicals from tens of thousands of records, with an emphasis on quantitative estimates of relevant points-of-departure from in vivo toxicology studies, such as no- and low- observable adverse effect levels, screening levels, reference doses, tolerable daily intake, etc." - }, - { - "name": "ToxValDB Cancer Summary Resource", - "description": "Collection of endpoints with cancer summary data. This curated data is sourced from the US EPA's Toxicity Values Database (ToxValDB)." - }, - { - "name": "ToxValDB Genetox Resource", - "description": "Collection of endpoints with genetoxicity data. This curated data is sourced from the US EPA's Toxicity Values Database (ToxValDB)." - }, - { - "name": "ToxValDB Skin Eye Resource", - "description": "Collection of endpoints with skin sensitization and eye irritation data. This curated data is sourced from the US EPA's Toxicity Values Database (ToxValDB)." - }, - { - "name": "ToxRefDb Effects Resource", - "description": "Collection of endpoints for guideline and guideline-like in vivo toxicity data curated in the US EPA's Toxicity Reference Database (ToxRefDB). This resource provides an export of all extracted dose-treatment group-effect information." - }, - { - "name": "ToxRefDB Data Resource", - "description": "Collection of endpoints for guideline and guideline-like in vivo toxicity data curated in the US EPA's Toxicity Reference Database (ToxRefDB). This resource provides an export of all extracted dose-treatment group-effect information as well as doses not eliciting effects." - }, - { - "name": "ToxRefDB Observation Resource", - "description": "Collection of endpoints for guideline and guideline-like in vivo toxicity data curated in the US EPA's Toxicity Reference Database (ToxRefDB). This resource provides an export of observations and endpoint observation status according to a relevant guideline profile." - }, - { - "name": "ToxRefDB Summary Resource", - "description": "Collection of endpoints for guideline and guideline-like in vivo toxicity data curated in the US EPA's Toxicity Reference Database (ToxRefDB). This resource provides study-chemical coverage summary information." - }, - { - "name": "ADME - IVIVE Resource", - "description": "Endpoint for in-vitro to in-vivo extrapolation (IVIVE) to predict a chemical's Absorption, Distribution, Metabolism, and Excretion (ADME) properties as provided on the CompTox Chemicals Dashboard's ADME>IVIVE tab" - }, - { - "name": "HAWC Resource", - "description": "Endpoint used by the populate CompTox Chemicals Dashboard (CCD) Literature> EPA HAWC tab. Health Assessment Workspace Collaborative (HAWC) is an interactive, expert-driven, content management system for human health assessments that is intended to promote transparency, data usability, and understanding of the data and decisions supporting an environmental and human health assessment. Links will be only be available for public assessments in HAWC." - }, - { - "name": "IRIS Resource", - "description": "Endpoint with IRIS data. US EPA's Integrated Risk Information System (IRIS) assessments can cover a chemical, a group of related chemicals, or a complex mixture. IRIS assessments are an important source of toxicity information used by EPA, state and local health agencies, other federal agencies, and international health organizations. A link is available on the CompTox Chemicals Dashboard (CCD) Literature> IRIS tab." - }, - { - "name": "PPRTV Resource", - "description": "Endpoint with PPRTV data. A Provisional Peer-Reviewed Toxicity Value (PPRTV) is a toxicity value primarily derived for use in EPA's Superfund Program. PPRTVs are derived from a review of the relevant scientific literature using EPA methods, sources of data and guidance for value derivation. A link is available on the CompTox Chemicals Dashboard (CCD) Literature> PPRTV tab." - } - ], - "paths": { - "/hazard/toxval/search/by-dtxsid/": { - "post": { - "tags": [ - "ToxValDB Resource" - ], - "summary": "Get data for a batch of DTXSID(s).", - "description": "Note: Maximum 200 DTXSIDs per request", - "operationId": "toxValDbDataByBatchDtxsid", - "requestBody": { - "description": "JSON array of DSSTox Substance Identifier", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "type": "string" - } - }, - "example": "[\"DTXSID7020182\",\"DTXSID9020112\"]" - } - }, - "required": true - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "string", - "oneOf": [ - { - "$ref": "#/components/schemas/ToxValDb" - } - ] - } - } - } - }, - "400": { - "description": "User has submitted more than allowed number (200) of DTXSID(s).", - "content": { - "application/json": { - "schema": { - "type": "string", - "oneOf": [ - { - "$ref": "#/components/schemas/ProblemDetail" - } - ] - }, - "example": { - "title": "Validation Error", - "status": 400, - "detail": "System supports requests of '200' DTXSIDs at one time, '202' were submitted." - } - } - } - } - }, - "security": [ - { - "api_key": [] - } - ] + { + "name": "ToxValDB Cancer Summary Resource", + "description": "Collection of endpoints with cancer summary data. This curated data is sourced from the US EPA's Toxicity Values Database (ToxValDB)." + }, + { + "name": "PPRTV Resource", + "description": "Endpoint with PPRTV data. A Provisional Peer-Reviewed Toxicity Value (PPRTV) is a toxicity value primarily derived for use in EPA's Superfund Program. PPRTVs are derived from a review of the relevant scientific literature using EPA methods, sources of data and guidance for value derivation. A link is available on the CompTox Chemicals Dashboard (CCD) Literature\u003E PPRTV tab." + }, + { + "name": "ToxValDB Skin Eye Resource", + "description": "Collection of endpoints with skin sensitization and eye irritation data. This curated data is sourced from the US EPA's Toxicity Values Database (ToxValDB)." + }, + { + "name": "ToxRefDb Effects Resource", + "description": "Collection of endpoints for guideline and guideline-like in vivo toxicity data curated in the US EPA's Toxicity Reference Database (ToxRefDB). This resource provides an export of all extracted dose-treatment group-effect information." + }, + { + "name": "ToxRefDB Observation Resource", + "description": "Collection of endpoints for guideline and guideline-like in vivo toxicity data curated in the US EPA's Toxicity Reference Database (ToxRefDB). This resource provides an export of observations and endpoint observation status according to a relevant guideline profile." + }, + { + "name": "IRIS Resource", + "description": "Endpoint with IRIS data. US EPA's Integrated Risk Information System (IRIS) assessments can cover a chemical, a group of related chemicals, or a complex mixture. IRIS assessments are an important source of toxicity information used by EPA, state and local health agencies, other federal agencies, and international health organizations. A link is available on the CompTox Chemicals Dashboard (CCD) Literature\u003E IRIS tab." + }, + { + "name": "ToxValDB Genetox Resource", + "description": "Collection of endpoints with genetoxicity data. This curated data is sourced from the US EPA's Toxicity Values Database (ToxValDB)." + }, + { + "name": "ToxRefDB Summary Resource", + "description": "Collection of endpoints for guideline and guideline-like in vivo toxicity data curated in the US EPA's Toxicity Reference Database (ToxRefDB). This resource provides study-chemical coverage summary information." + }, + { + "name": "ToxRefDB Data Resource", + "description": "Collection of endpoints for guideline and guideline-like in vivo toxicity data curated in the US EPA's Toxicity Reference Database (ToxRefDB). This resource provides an export of all extracted dose-treatment group-effect information as well as doses not eliciting effects." + }, + { + "name": "ADME - IVIVE Resource", + "description": "Endpoint for in-vitro to in-vivo extrapolation (IVIVE) to predict a chemical's Absorption, Distribution, Metabolism, and Excretion (ADME) properties as provided on the CompTox Chemicals Dashboard's ADME\u003EIVIVE tab" + }, + { + "name": "HAWC Resource", + "description": "Endpoint used by the populate CompTox Chemicals Dashboard (CCD) Literature\u003E EPA HAWC tab. Health Assessment Workspace Collaborative (HAWC) is an interactive, expert-driven, content management system for human health assessments that is intended to promote transparency, data usability, and understanding of the data and decisions supporting an environmental and human health assessment. Links will be only be available for public assessments in HAWC." + } + ], + "paths": { + "/hazard/toxval/search/by-dtxsid/": { + "post": { + "tags": [ + "ToxValDB Resource" + ], + "summary": "Get data for a batch of DTXSID(s).", + "description": "Note: Maximum 200 DTXSIDs per request", + "operationId": "toxValDbDataByBatchDtxsid", + "requestBody": { + "description": "JSON array of DSSTox Substance Identifier", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "example": "[\"DTXSID7020182\",\"DTXSID9020112\"]" } + }, + "required": true }, - "/hazard/skin-eye/search/by-dtxsid/": { - "post": { - "tags": [ - "ToxValDB Skin Eye Resource" - ], - "summary": "Get data for a batch of DTXSID(s)", - "description": "return skin-eye data for requested DTXSIDs. Note: Maximum 200 DTXSIDs per request", - "operationId": "skinEyedBatch", - "requestBody": { - "description": "JSON array of DSSTox Substance Identifier", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "type": "string" - } - }, - "example": "[\"DTXSID7020182\",\"DTXSID9020112\"]" - } - }, - "required": true - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "string", - "oneOf": [ - { - "$ref": "#/components/schemas/SkinEye" - } - ] - } - } - } - }, - "400": { - "description": "User has submitted more than allowed number (200) of DTXSID(s).", - "content": { - "application/json": { - "schema": { - "type": "string", - "oneOf": [ - { - "$ref": "#/components/schemas/ProblemDetail" - } - ] - }, - "example": { - "title": "Validation Error", - "status": 400, - "detail": "System supports requests of '200' DTXSIDs at one time, '202' were submitted." - } - } - } - } - }, - "security": [ + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "string", + "oneOf": [ { - "api_key": [] + "$ref": "#/components/schemas/ToxValDb" } - ] + ] + } + } } - }, - "/hazard/genetox/summary/search/by-dtxsid/": { - "post": { - "tags": [ - "ToxValDB Genetox Resource" - ], - "summary": "Get summary data for a batch of DTXSID", - "description": "return genetox summary data for requested DTXSIDs. Note: Maximum 200 DTXSIDs per request", - "operationId": "batchSearchSummary", - "requestBody": { - "description": "JSON array of DSSTox Substance Identifier", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "type": "string" - } - }, - "example": "[\"DTXSID7020182\",\"DTXSID9020112\"]" - } - }, - "required": true - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "string", - "oneOf": [ - { - "$ref": "#/components/schemas/GenetoxSummary" - } - ] - } - } - } - }, - "400": { - "description": "When user has submitted more than allowed number (200) of DTXSID(s).", - "content": { - "application/json": { - "schema": { - "type": "string", - "oneOf": [ - { - "$ref": "#/components/schemas/ProblemDetail" - } - ] - }, - "example": { - "title": "Validation Error", - "status": 400, - "detail": "SSystem supports requests of '200' DTXSIDs at one time, '202' were submitted." - } - } - } - } - }, - "security": [ + }, + "400": { + "description": "User has submitted more than allowed number (200) of DTXSID(s).", + "content": { + "application/json": { + "schema": { + "type": "string", + "oneOf": [ { - "api_key": [] + "$ref": "#/components/schemas/ProblemDetail" } - ] + ] + }, + "example": { + "title": "Validation Error", + "status": 400, + "detail": "System supports requests of '200' DTXSIDs at one time, '202' were submitted." + } + } } + } }, - "/hazard/genetox/details/search/by-dtxsid/": { - "post": { - "tags": [ - "ToxValDB Genetox Resource" - ], - "summary": "Get detailed data for a batch of DTXSIDs", - "description": "return detailed data for requested DTXSIDs. Note: Maximum 200 DTXSIDs per request", - "operationId": "batchSearch", - "requestBody": { - "description": "JSON array of DSSTox Substance Identifier", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "type": "string" - } - }, - "example": "[\"DTXSID7020182\",\"DTXSID9020112\"]" - } - }, - "required": true - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "string", - "oneOf": [ - { - "$ref": "#/components/schemas/GenetoxDetail" - } - ] - } - } - } - }, - "400": { - "description": "User has submitted more than allowed number (200) of DTXSID(s).", - "content": { - "application/json": { - "schema": { - "type": "string", - "oneOf": [ - { - "$ref": "#/components/schemas/ProblemDetail" - } - ] - }, - "example": { - "title": "Validation Error", - "status": 400, - "detail": "System supports requests of '200' DTXSIDs at one time, '202' were submitted." - } - } - } - } - }, - "security": [ - { - "api_key": [] - } - ] + "security": [ + { + "api_key": [] + } + ] + } + }, + "/hazard/skin-eye/search/by-dtxsid/": { + "post": { + "tags": [ + "ToxValDB Skin Eye Resource" + ], + "summary": "Get data for a batch of DTXSID(s)", + "description": "return skin-eye data for requested DTXSIDs. Note: Maximum 200 DTXSIDs per request", + "operationId": "skinEyedBatch", + "requestBody": { + "description": "JSON array of DSSTox Substance Identifier", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "example": "[\"DTXSID7020182\",\"DTXSID9020112\"]" } + }, + "required": true }, - "/hazard/cancer-summary/search/by-dtxsid/": { - "post": { - "tags": [ - "ToxValDB Cancer Summary Resource" - ], - "summary": "Get data for a batch of DTXSIDs", - "description": "return cancer summary data for requested DTXSIDs. Note: Maximum 200 DTXSIDs per request", - "operationId": "cancerSummaryBatch", - "requestBody": { - "description": "JSON array of DSSTox Substance Identifiers", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "type": "string" - } - }, - "example": "[\"DTXSID7020182\",\"DTXSID9020112\"]" - } - }, - "required": true - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "string", - "oneOf": [ - { - "$ref": "#/components/schemas/CancerSummary" - } - ] - } - } - } - }, - "400": { - "description": "User has submitted more than allowed number (200) of DTXSID(s).", - "content": { - "application/json": { - "schema": { - "type": "string", - "oneOf": [ - { - "$ref": "#/components/schemas/ProblemDetail" - } - ] - }, - "example": { - "title": "Validation Error", - "status": 400, - "detail": "System supports requests of '200' dtxsids at one time, '202' were submitted." - } - } - } - } - }, - "security": [ + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "string", + "oneOf": [ { - "api_key": [] + "$ref": "#/components/schemas/SkinEye" } - ] + ] + } + } } - }, - "/hazard/toxval/supercategory/search/by-dtxsid/{dtxsid}": { - "get": { - "tags": [ - "ToxValDB Resource" - ], - "summary": "Get all toxval supercategories by dtxsid", - "operationId": "getToxValSuperCategoriesByDtxsid", - "parameters": [ + }, + "400": { + "description": "User has submitted more than allowed number (200) of DTXSID(s).", + "content": { + "application/json": { + "schema": { + "type": "string", + "oneOf": [ { - "name": "dtxsid", - "in": "path", - "description": "DSSTox Substance Identifier", - "required": true, - "schema": { - "type": "string" - }, - "example": "DTXSID0021125" - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "string", - "oneOf": [ - { - "$ref": "#/components/schemas/ToxValDb" - } - ] - } - } - } + "$ref": "#/components/schemas/ProblemDetail" } + ] }, - "security": [ - { - "api_key": [] - } - ] + "example": { + "title": "Validation Error", + "status": 400, + "detail": "System supports requests of '200' DTXSIDs at one time, '202' were submitted." + } + } } + } }, - "/hazard/toxval/search/by-dtxsid/{dtxsid}": { - "get": { - "tags": [ - "ToxValDB Resource" - ], - "summary": "Get data by DTXSID", - "operationId": "getToxValDbDataByDtxsid", - "parameters": [ - { - "name": "dtxsid", - "in": "path", - "description": "DSSTox Substance Identifier", - "required": true, - "schema": { - "type": "string" - }, - "example": "DTXSID0021125" - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "string", - "oneOf": [ - { - "$ref": "#/components/schemas/ToxValDb" - } - ] - } - } - } - } - }, - "security": [ - { - "api_key": [] - } - ] + "security": [ + { + "api_key": [] + } + ] + } + }, + "/hazard/genetox/summary/search/by-dtxsid/": { + "post": { + "tags": [ + "ToxValDB Genetox Resource" + ], + "summary": "Get summary data for a batch of DTXSID", + "description": "return genetox summary data for requested DTXSIDs. Note: Maximum 200 DTXSIDs per request", + "operationId": "batchSearchSummary", + "requestBody": { + "description": "JSON array of DSSTox Substance Identifier", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "example": "[\"DTXSID7020182\",\"DTXSID9020112\"]" } + }, + "required": true }, - "/hazard/toxval/search/by-category/{dtxsid}": { - "get": { - "tags": [ - "ToxValDB Resource" - ], - "summary": "Get all data by dtxsid and category", - "operationId": "getToxValDbDataByDtxsidAndCategory", - "parameters": [ - { - "name": "dtxsid", - "in": "path", - "description": "DSSTox Substance Identifier", - "required": true, - "schema": { - "type": "string" - }, - "example": "DTXSID0021125" - }, - { - "name": "category", - "in": "query", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "string", - "oneOf": [ - { - "$ref": "#/components/schemas/ToxValDb" - } - ] - } - } - } - } - }, - "security": [ + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "string", + "oneOf": [ { - "api_key": [] + "$ref": "#/components/schemas/GenetoxSummary" } - ] + ] + } + } } - }, - "/hazard/toxref/summary/search/by-study-type/{studyType}": { - "get": { - "tags": [ - "ToxRefDB Summary Resource" - ], - "summary": "Get summary data by Study Type", - "description": "return ToxRefDB summary information by study type", - "operationId": "toxRefSummaryByStudyType", - "parameters": [ + }, + "400": { + "description": "When user has submitted more than allowed number (200) of DTXSID(s).", + "content": { + "application/json": { + "schema": { + "type": "string", + "oneOf": [ { - "name": "studyType", - "in": "path", - "description": "Study Type", - "required": true, - "schema": { - "type": "string" - }, - "example": "DEV" - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "string", - "oneOf": [ - { - "$ref": "#/components/schemas/ToxRefSummary" - } - ] - } - } - } + "$ref": "#/components/schemas/ProblemDetail" } + ] }, - "security": [ - { - "api_key": [] - } - ] + "example": { + "title": "Validation Error", + "status": 400, + "detail": "SSystem supports requests of '200' DTXSIDs at one time, '202' were submitted." + } + } } + } }, - "/hazard/toxref/summary/search/by-study-id/{studyId}": { - "get": { - "tags": [ - "ToxRefDB Summary Resource" - ], - "summary": "Get summary data by Study ID", - "description": "return ToxRefDB summary information by study id", - "operationId": "toxRefSummaryByStudyId", - "parameters": [ - { - "name": "studyId", - "in": "path", - "description": "Study ID", - "required": true, - "schema": { - "type": "integer", - "format": "int32" - }, - "example": 63 - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "string", - "oneOf": [ - { - "$ref": "#/components/schemas/ToxRefSummary" - } - ] - } - } - } - } - }, - "security": [ - { - "api_key": [] - } - ] + "security": [ + { + "api_key": [] + } + ] + } + }, + "/hazard/genetox/details/search/by-dtxsid/": { + "post": { + "tags": [ + "ToxValDB Genetox Resource" + ], + "summary": "Get detailed data for a batch of DTXSIDs", + "description": "return detailed data for requested DTXSIDs. Note: Maximum 200 DTXSIDs per request", + "operationId": "batchSearch", + "requestBody": { + "description": "JSON array of DSSTox Substance Identifier", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "example": "[\"DTXSID7020182\",\"DTXSID9020112\"]" } + }, + "required": true }, - "/hazard/toxref/summary/search/by-dtxsid/{dtxsid}": { - "get": { - "tags": [ - "ToxRefDB Summary Resource" - ], - "summary": "Get summary data by DTXSID", - "description": "return ToxRefDB summary information by DTXSID", - "operationId": "toxRefSummaryByDtxsid", - "parameters": [ - { - "name": "dtxsid", - "in": "path", - "description": "dtxsid", - "required": true, - "schema": { - "type": "string" - }, - "example": "DTXSID1037806" - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "string", - "oneOf": [ - { - "$ref": "#/components/schemas/ToxRefSummary" - } - ] - } - } - } - } - }, - "security": [ + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "string", + "oneOf": [ { - "api_key": [] + "$ref": "#/components/schemas/GenetoxDetail" } - ] + ] + } + } } - }, - "/hazard/toxref/observations/search/by-study-type/{studyType}": { - "get": { - "tags": [ - "ToxRefDB Observation Resource" - ], - "summary": "Get observations by Study Type", - "operationId": "toxRefObsByStudyType", - "parameters": [ - { - "name": "studyType", - "in": "path", - "description": "Study Type", - "required": true, - "schema": { - "type": "string" - }, - "example": "DEV" - }, + }, + "400": { + "description": "User has submitted more than allowed number (200) of DTXSID(s).", + "content": { + "application/json": { + "schema": { + "type": "string", + "oneOf": [ { - "name": "pageNumber", - "in": "query", - "required": false, - "schema": { - "type": "integer", - "format": "int32", - "default": 1 - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "string", - "oneOf": [ - { - "$ref": "#/components/schemas/ToxRefObs" - } - ] - } - } - } + "$ref": "#/components/schemas/ProblemDetail" } + ] }, - "security": [ - { - "api_key": [] - } - ] + "example": { + "title": "Validation Error", + "status": 400, + "detail": "System supports requests of '200' DTXSIDs at one time, '202' were submitted." + } + } } + } }, - "/hazard/toxref/observations/search/by-study-id/{studyId}": { - "get": { - "tags": [ - "ToxRefDB Observation Resource" - ], - "summary": "Get observations by Study ID", - "operationId": "toxRefObsByStudyId", - "parameters": [ - { - "name": "studyId", - "in": "path", - "description": "Study ID", - "required": true, - "schema": { - "type": "integer", - "format": "int32" - }, - "example": 63 - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "string", - "oneOf": [ - { - "$ref": "#/components/schemas/ToxRefObs" - } - ] - } - } - } - } - }, - "security": [ - { - "api_key": [] - } - ] + "security": [ + { + "api_key": [] + } + ] + } + }, + "/hazard/cancer-summary/search/by-dtxsid/": { + "post": { + "tags": [ + "ToxValDB Cancer Summary Resource" + ], + "summary": "Get data for a batch of DTXSIDs", + "description": "return cancer summary data for requested DTXSIDs. Note: Maximum 200 DTXSIDs per request", + "operationId": "cancerSummaryBatch", + "requestBody": { + "description": "JSON array of DSSTox Substance Identifiers", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "example": "[\"DTXSID7020182\",\"DTXSID9020112\"]" } + }, + "required": true }, - "/hazard/toxref/observations/search/by-dtxsid/{dtxsid}": { - "get": { - "tags": [ - "ToxRefDB Observation Resource" - ], - "summary": "Get observations by DTXSID", - "operationId": "toxRefObsByDtxsid", - "parameters": [ - { - "name": "dtxsid", - "in": "path", - "description": "dtxsid", - "required": true, - "schema": { - "type": "string" - }, - "example": "DTXSID1037806" - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "string", - "oneOf": [ - { - "$ref": "#/components/schemas/ToxRefObs" - } - ] - } - } - } - } - }, - "security": [ + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "string", + "oneOf": [ { - "api_key": [] + "$ref": "#/components/schemas/CancerSummary" } - ] + ] + } + } } - }, - "/hazard/toxref/effects/search/by-study-type/{studyType}": { - "get": { - "tags": [ - "ToxRefDb Effects Resource" - ], - "summary": "Get effects data by Study Type", - "operationId": "toxRefEffectsByStudyType", - "parameters": [ - { - "name": "studyType", - "in": "path", - "description": "Study Type", - "required": true, - "schema": { - "type": "string" - }, - "example": "DEV" - }, + }, + "400": { + "description": "User has submitted more than allowed number (200) of DTXSID(s).", + "content": { + "application/json": { + "schema": { + "type": "string", + "oneOf": [ { - "name": "pageNumber", - "in": "query", - "required": false, - "schema": { - "type": "integer", - "format": "int32", - "default": 1 - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "string", - "oneOf": [ - { - "$ref": "#/components/schemas/ToxRefEffects" - } - ] - } - } - } + "$ref": "#/components/schemas/ProblemDetail" } + ] }, - "security": [ - { - "api_key": [] - } - ] + "example": { + "title": "Validation Error", + "status": 400, + "detail": "System supports requests of '200' dtxsids at one time, '202' were submitted." + } + } } + } }, - "/hazard/toxref/effects/search/by-study-id/{studyId}": { - "get": { - "tags": [ - "ToxRefDb Effects Resource" - ], - "summary": "Get effects data by Study ID", - "operationId": "toxRefEffectsByStudyId", - "parameters": [ + "security": [ + { + "api_key": [] + } + ] + } + }, + "/hazard/toxval/supercategory/search/by-dtxsid/{dtxsid}": { + "get": { + "tags": [ + "ToxValDB Resource" + ], + "summary": "Get all toxval supercategories by dtxsid", + "operationId": "getToxValSuperCategoriesByDtxsid", + "parameters": [ + { + "name": "dtxsid", + "in": "path", + "description": "DSSTox Substance Identifier", + "required": true, + "schema": { + "type": "string" + }, + "example": "DTXSID0021125" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "string", + "oneOf": [ { - "name": "studyId", - "in": "path", - "description": "Study ID", - "required": true, - "schema": { - "type": "integer", - "format": "int32" - }, - "example": 63 - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "string", - "oneOf": [ - { - "$ref": "#/components/schemas/ToxRefEffects" - } - ] - } - } - } + "$ref": "#/components/schemas/ToxValDb" } - }, - "security": [ + ] + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/hazard/toxval/search/by-dtxsid/{dtxsid}": { + "get": { + "tags": [ + "ToxValDB Resource" + ], + "summary": "Get data by DTXSID", + "operationId": "getToxValDbDataByDtxsid", + "parameters": [ + { + "name": "dtxsid", + "in": "path", + "description": "DSSTox Substance Identifier", + "required": true, + "schema": { + "type": "string" + }, + "example": "DTXSID0021125" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "string", + "oneOf": [ { - "api_key": [] + "$ref": "#/components/schemas/ToxValDb" } - ] + ] + } + } } + } }, - "/hazard/toxref/effects/search/by-dtxsid/{dtxsid}": { - "get": { - "tags": [ - "ToxRefDb Effects Resource" - ], - "summary": "Get effects data by DTXSID", - "operationId": "toxRefEffectsByDtxsid", - "parameters": [ + "security": [ + { + "api_key": [] + } + ] + } + }, + "/hazard/toxval/search/by-category/{dtxsid}": { + "get": { + "tags": [ + "ToxValDB Resource" + ], + "summary": "Get all data by dtxsid and category", + "operationId": "getToxValDbDataByDtxsidAndCategory", + "parameters": [ + { + "name": "dtxsid", + "in": "path", + "description": "DSSTox Substance Identifier", + "required": true, + "schema": { + "type": "string" + }, + "example": "DTXSID0021125" + }, + { + "name": "category", + "in": "query", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "string", + "oneOf": [ { - "name": "dtxsid", - "in": "path", - "description": "dtxsid", - "required": true, - "schema": { - "type": "string" - }, - "example": "DTXSID1037806" + "$ref": "#/components/schemas/ToxValDb" } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "string", - "oneOf": [ - { - "$ref": "#/components/schemas/ToxRefEffects" - } - ] - } - } - } - } - }, - "security": [ + ] + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/hazard/toxref/summary/search/by-study-type/{studyType}": { + "get": { + "tags": [ + "ToxRefDB Summary Resource" + ], + "summary": "Get summary data by Study Type", + "description": "return ToxRefDB summary information by study type", + "operationId": "toxRefSummaryByStudyType", + "parameters": [ + { + "name": "studyType", + "in": "path", + "description": "Study Type", + "required": true, + "schema": { + "type": "string" + }, + "example": "DEV" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "string", + "oneOf": [ { - "api_key": [] + "$ref": "#/components/schemas/ToxRefSummary" } - ] + ] + } + } } + } }, - "/hazard/toxref/data/search/by-study-type/{studyType}": { - "get": { - "tags": [ - "ToxRefDB Data Resource" - ], - "summary": "Get all data by Study Type", - "operationId": "toxRefDataByStudyType", - "parameters": [ - { - "name": "studyType", - "in": "path", - "description": "Study Type", - "required": true, - "schema": { - "type": "string" - }, - "example": "DEV" - }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/hazard/toxref/summary/search/by-study-id/{studyId}": { + "get": { + "tags": [ + "ToxRefDB Summary Resource" + ], + "summary": "Get summary data by Study ID", + "description": "return ToxRefDB summary information by study id", + "operationId": "toxRefSummaryByStudyId", + "parameters": [ + { + "name": "studyId", + "in": "path", + "description": "Study ID", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + }, + "example": 63 + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "string", + "oneOf": [ { - "name": "pageNumber", - "in": "query", - "required": false, - "schema": { - "type": "integer", - "format": "int32", - "default": 1 - } + "$ref": "#/components/schemas/ToxRefSummary" } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "string", - "oneOf": [ - { - "$ref": "#/components/schemas/ToxRefData" - } - ] - } - } - } - } - }, - "security": [ + ] + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/hazard/toxref/summary/search/by-dtxsid/{dtxsid}": { + "get": { + "tags": [ + "ToxRefDB Summary Resource" + ], + "summary": "Get summary data by DTXSID", + "description": "return ToxRefDB summary information by DTXSID", + "operationId": "toxRefSummaryByDtxsid", + "parameters": [ + { + "name": "dtxsid", + "in": "path", + "description": "dtxsid", + "required": true, + "schema": { + "type": "string" + }, + "example": "DTXSID1037806" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "string", + "oneOf": [ { - "api_key": [] + "$ref": "#/components/schemas/ToxRefSummary" } - ] + ] + } + } } + } }, - "/hazard/toxref/data/search/by-study-id/{studyId}": { - "get": { - "tags": [ - "ToxRefDB Data Resource" - ], - "summary": "Get all data by Study ID", - "operationId": "toxRefDataByStudyId", - "parameters": [ + "security": [ + { + "api_key": [] + } + ] + } + }, + "/hazard/toxref/observations/search/by-study-type/{studyType}": { + "get": { + "tags": [ + "ToxRefDB Observation Resource" + ], + "summary": "Get observations by Study Type", + "operationId": "toxRefObsByStudyType", + "parameters": [ + { + "name": "studyType", + "in": "path", + "description": "Study Type", + "required": true, + "schema": { + "type": "string" + }, + "example": "DEV" + }, + { + "name": "pageNumber", + "in": "query", + "required": false, + "schema": { + "type": "integer", + "format": "int32", + "default": 1 + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "string", + "oneOf": [ { - "name": "studyId", - "in": "path", - "description": "Study ID", - "required": true, - "schema": { - "type": "integer", - "format": "int32" - }, - "example": 63 - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "string", - "oneOf": [ - { - "$ref": "#/components/schemas/ToxRefData" - } - ] - } - } - } + "$ref": "#/components/schemas/ToxRefObs" } - }, - "security": [ + ] + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/hazard/toxref/observations/search/by-study-id/{studyId}": { + "get": { + "tags": [ + "ToxRefDB Observation Resource" + ], + "summary": "Get observations by Study ID", + "operationId": "toxRefObsByStudyId", + "parameters": [ + { + "name": "studyId", + "in": "path", + "description": "Study ID", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + }, + "example": 63 + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "string", + "oneOf": [ { - "api_key": [] + "$ref": "#/components/schemas/ToxRefObs" } - ] + ] + } + } } + } }, - "/hazard/toxref/data/search/by-dtxsid/{dtxsid}": { - "get": { - "tags": [ - "ToxRefDB Data Resource" - ], - "summary": "Get all data by DTXSID", - "operationId": "toxRefDataByDtxsid", - "parameters": [ + "security": [ + { + "api_key": [] + } + ] + } + }, + "/hazard/toxref/observations/search/by-dtxsid/{dtxsid}": { + "get": { + "tags": [ + "ToxRefDB Observation Resource" + ], + "summary": "Get observations by DTXSID", + "operationId": "toxRefObsByDtxsid", + "parameters": [ + { + "name": "dtxsid", + "in": "path", + "description": "dtxsid", + "required": true, + "schema": { + "type": "string" + }, + "example": "DTXSID1037806" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "string", + "oneOf": [ { - "name": "dtxsid", - "in": "path", - "description": "dtxsid", - "required": true, - "schema": { - "type": "string" - }, - "example": "DTXSID1037806" - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "string", - "oneOf": [ - { - "$ref": "#/components/schemas/ToxRefData" - } - ] - } - } - } + "$ref": "#/components/schemas/ToxRefObs" } - }, - "security": [ + ] + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/hazard/toxref/effects/search/by-study-type/{studyType}": { + "get": { + "tags": [ + "ToxRefDb Effects Resource" + ], + "summary": "Get effects data by Study Type", + "operationId": "toxRefEffectsByStudyType", + "parameters": [ + { + "name": "studyType", + "in": "path", + "description": "Study Type", + "required": true, + "schema": { + "type": "string" + }, + "example": "DEV" + }, + { + "name": "pageNumber", + "in": "query", + "required": false, + "schema": { + "type": "integer", + "format": "int32", + "default": 1 + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "string", + "oneOf": [ { - "api_key": [] + "$ref": "#/components/schemas/ToxRefEffects" } - ] + ] + } + } } + } }, - "/hazard/skin-eye/search/by-dtxsid/{dtxsid}": { - "get": { - "tags": [ - "ToxValDB Skin Eye Resource" - ], - "summary": "Get data by DTXSID", - "operationId": "skinEyedByDtxsid", - "parameters": [ + "security": [ + { + "api_key": [] + } + ] + } + }, + "/hazard/toxref/effects/search/by-study-id/{studyId}": { + "get": { + "tags": [ + "ToxRefDb Effects Resource" + ], + "summary": "Get effects data by Study ID", + "operationId": "toxRefEffectsByStudyId", + "parameters": [ + { + "name": "studyId", + "in": "path", + "description": "Study ID", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + }, + "example": 63 + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "string", + "oneOf": [ { - "name": "dtxsid", - "in": "path", - "description": "DSSTox Substance Identifier", - "required": true, - "schema": { - "type": "string" - }, - "example": "DTXSID0021125" + "$ref": "#/components/schemas/ToxRefEffects" } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "string", - "oneOf": [ - { - "$ref": "#/components/schemas/SkinEye" - } - ] - } - } - } - } - }, - "security": [ + ] + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/hazard/toxref/effects/search/by-dtxsid/{dtxsid}": { + "get": { + "tags": [ + "ToxRefDb Effects Resource" + ], + "summary": "Get effects data by DTXSID", + "operationId": "toxRefEffectsByDtxsid", + "parameters": [ + { + "name": "dtxsid", + "in": "path", + "description": "dtxsid", + "required": true, + "schema": { + "type": "string" + }, + "example": "DTXSID1037806" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "string", + "oneOf": [ { - "api_key": [] + "$ref": "#/components/schemas/ToxRefEffects" } - ] + ] + } + } } + } }, - "/hazard/pprtv/search/by-dtxsid/{dtxsid}": { - "get": { - "tags": [ - "PPRTV Resource" - ], - "summary": "Get PPRTV data by DTXSID", - "operationId": "pprtvChemicalsByDtxsid", - "parameters": [ + "security": [ + { + "api_key": [] + } + ] + } + }, + "/hazard/toxref/data/search/by-study-type/{studyType}": { + "get": { + "tags": [ + "ToxRefDB Data Resource" + ], + "summary": "Get all data by Study Type", + "operationId": "toxRefDataByStudyType", + "parameters": [ + { + "name": "studyType", + "in": "path", + "description": "Study Type", + "required": true, + "schema": { + "type": "string" + }, + "example": "DEV" + }, + { + "name": "pageNumber", + "in": "query", + "required": false, + "schema": { + "type": "integer", + "format": "int32", + "default": 1 + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "string", + "oneOf": [ { - "name": "dtxsid", - "in": "path", - "description": "DSSTox Substance Identifier", - "required": true, - "schema": { - "type": "string" - }, - "example": "DTXSID2040282" - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "string", - "oneOf": [ - { - "$ref": "#/components/schemas/Pprtv" - } - ] - } - } - } + "$ref": "#/components/schemas/ToxRefData" } - }, - "security": [ + ] + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/hazard/toxref/data/search/by-study-id/{studyId}": { + "get": { + "tags": [ + "ToxRefDB Data Resource" + ], + "summary": "Get all data by Study ID", + "operationId": "toxRefDataByStudyId", + "parameters": [ + { + "name": "studyId", + "in": "path", + "description": "Study ID", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + }, + "example": 63 + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "string", + "oneOf": [ { - "api_key": [] + "$ref": "#/components/schemas/ToxRefData" } - ] + ] + } + } } + } }, - "/hazard/iris/search/by-dtxsid/{dtxsid}": { - "get": { - "tags": [ - "IRIS Resource" - ], - "summary": "Get IRIS data by DTXSID", - "operationId": "irisDataByDtxsid", - "parameters": [ + "security": [ + { + "api_key": [] + } + ] + } + }, + "/hazard/toxref/data/search/by-dtxsid/{dtxsid}": { + "get": { + "tags": [ + "ToxRefDB Data Resource" + ], + "summary": "Get all data by DTXSID", + "operationId": "toxRefDataByDtxsid", + "parameters": [ + { + "name": "dtxsid", + "in": "path", + "description": "dtxsid", + "required": true, + "schema": { + "type": "string" + }, + "example": "DTXSID1037806" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "string", + "oneOf": [ { - "name": "dtxsid", - "in": "path", - "description": "DSSTox Substance Identifier", - "required": true, - "schema": { - "type": "string" - }, - "example": "DTXSID7020182" - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "string", - "oneOf": [ - { - "$ref": "#/components/schemas/Iris" - } - ] - } - } - } + "$ref": "#/components/schemas/ToxRefData" } - }, - "security": [ + ] + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/hazard/skin-eye/search/by-dtxsid/{dtxsid}": { + "get": { + "tags": [ + "ToxValDB Skin Eye Resource" + ], + "summary": "Get data by DTXSID", + "operationId": "skinEyedByDtxsid", + "parameters": [ + { + "name": "dtxsid", + "in": "path", + "description": "DSSTox Substance Identifier", + "required": true, + "schema": { + "type": "string" + }, + "example": "DTXSID0021125" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "string", + "oneOf": [ { - "api_key": [] + "$ref": "#/components/schemas/SkinEye" } - ] + ] + } + } } + } }, - "/hazard/hawc/search/by-dtxsid/{dtxsid}": { - "get": { - "tags": [ - "HAWC Resource" - ], - "summary": "Get HAWC link by DTXSID", - "description": "return HAWC link for requested DTXSID", - "operationId": "hawcDataByDtxsid", - "parameters": [ + "security": [ + { + "api_key": [] + } + ] + } + }, + "/hazard/pprtv/search/by-dtxsid/{dtxsid}": { + "get": { + "tags": [ + "PPRTV Resource" + ], + "summary": "Get PPRTV data by DTXSID", + "operationId": "pprtvChemicalsByDtxsid", + "parameters": [ + { + "name": "dtxsid", + "in": "path", + "description": "DSSTox Substance Identifier", + "required": true, + "schema": { + "type": "string" + }, + "example": "DTXSID2040282" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "string", + "oneOf": [ { - "name": "dtxsid", - "in": "path", - "description": "DSSTox Substance Identifier", - "required": true, - "schema": { - "type": "string" - }, - "example": "DTXSID7020182" - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "string", - "oneOf": [ - { - "$ref": "#/components/schemas/Hawc" - } - ] - } - } - } + "$ref": "#/components/schemas/Pprtv" } - }, - "security": [ + ] + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/hazard/iris/search/by-dtxsid/{dtxsid}": { + "get": { + "tags": [ + "IRIS Resource" + ], + "summary": "Get IRIS data by DTXSID", + "operationId": "irisDataByDtxsid", + "parameters": [ + { + "name": "dtxsid", + "in": "path", + "description": "DSSTox Substance Identifier", + "required": true, + "schema": { + "type": "string" + }, + "example": "DTXSID7020182" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "string", + "oneOf": [ { - "api_key": [] + "$ref": "#/components/schemas/Iris" } - ] + ] + } + } } + } }, - "/hazard/genetox/summary/search/by-dtxsid/{dtxsid}": { - "get": { - "tags": [ - "ToxValDB Genetox Resource" - ], - "summary": "Get summary data by DTXSID", - "operationId": "genetoxSummaryByDtxsid", - "parameters": [ + "security": [ + { + "api_key": [] + } + ] + } + }, + "/hazard/hawc/search/by-dtxsid/{dtxsid}": { + "get": { + "tags": [ + "HAWC Resource" + ], + "summary": "Get HAWC link by DTXSID", + "description": "return HAWC link for requested DTXSID", + "operationId": "hawcDataByDtxsid", + "parameters": [ + { + "name": "dtxsid", + "in": "path", + "description": "DSSTox Substance Identifier", + "required": true, + "schema": { + "type": "string" + }, + "example": "DTXSID7020182" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "string", + "oneOf": [ { - "name": "dtxsid", - "in": "path", - "description": "DSSTox Substance Identifier", - "required": true, - "schema": { - "type": "string" - }, - "example": "DTXSID0021125" - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "string", - "oneOf": [ - { - "$ref": "#/components/schemas/GenetoxSummary" - } - ] - } - } - } + "$ref": "#/components/schemas/Hawc" } - }, - "security": [ + ] + } + } + } + } + }, + "security": [ + { + "api_key": [] + } + ] + } + }, + "/hazard/genetox/summary/search/by-dtxsid/{dtxsid}": { + "get": { + "tags": [ + "ToxValDB Genetox Resource" + ], + "summary": "Get summary data by DTXSID", + "operationId": "genetoxSummaryByDtxsid", + "parameters": [ + { + "name": "dtxsid", + "in": "path", + "description": "DSSTox Substance Identifier", + "required": true, + "schema": { + "type": "string" + }, + "example": "DTXSID0021125" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "string", + "oneOf": [ { - "api_key": [] + "$ref": "#/components/schemas/GenetoxSummary" } - ] + ] + } + } } + } }, - "/hazard/genetox/details/search/by-dtxsid/{dtxsid}": { - "get": { - "tags": [ - "ToxValDB Genetox Resource" - ], - "summary": "Get detailed data by DTXSID with CCD projection", - "description": "return genetox details for requested DTXSID. There is an available projection aligned with what's available on the CCD Genetoxicity Details page:ccd-genetox-details. If no projection is specified, the default GenetoxDetails data will be returned.", - "operationId": "getGenetoxDetailsByDtxsid", - "parameters": [ + "security": [ + { + "api_key": [] + } + ] + } + }, + "/hazard/genetox/details/search/by-dtxsid/{dtxsid}": { + "get": { + "tags": [ + "ToxValDB Genetox Resource" + ], + "summary": "Get detailed data by DTXSID with CCD projection", + "description": "return genetox details for requested DTXSID. There is an available projection aligned with what's available on the CCD Genetoxicity Details page:ccd-genetox-details. If no projection is specified, the default GenetoxDetails data will be returned.", + "operationId": "getGenetoxDetailsByDtxsid", + "parameters": [ + { + "name": "dtxsid", + "in": "path", + "description": "DSSTox Substance Identifier", + "required": true, + "schema": { + "type": "string" + }, + "example": "DTXSID7020182" + }, + { + "name": "projection", + "in": "query", + "description": "Specifies if projection is used. Option: ccd-genetox-details. If no projection is specified, the default GenetoxDetail projection is returned.", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "string", + "oneOf": [ { - "name": "dtxsid", - "in": "path", - "description": "DSSTox Substance Identifier", - "required": true, - "schema": { - "type": "string" - }, - "example": "DTXSID7020182" + "$ref": "#/components/schemas/GenetoxDetail" }, { - "name": "projection", - "in": "query", - "description": "Specifies if projection is used. Option: ccd-genetox-details. If no projection is specified, the default GenetoxDetail projection is returned.", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "string", - "oneOf": [ - { - "$ref": "#/components/schemas/GenetoxDetail" - }, - { - "$ref": "#/components/schemas/CcdGenetoxDetail" - } - ] - } - } - } - } - }, - "security": [ - { - "api_key": [] + "$ref": "#/components/schemas/CcdGenetoxDetail" } - ] + ] + } + } } + } }, - "/hazard/cancer-summary/search/by-dtxsid/{dtxsid}": { - "get": { - "tags": [ - "ToxValDB Cancer Summary Resource" - ], - "summary": "Get data by DTXSID", - "description": "return cancer summary data for requested DTXSID", - "operationId": "cancerSummaryByDtxsid", - "parameters": [ - { - "name": "dtxsid", - "in": "path", - "description": "DSSTox Substance Identifier", - "required": true, - "schema": { - "type": "string" - }, - "example": "DTXSID0021125" - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "string", - "oneOf": [ - { - "$ref": "#/components/schemas/CancerSummary" - } - ] - } - } - } - } - }, - "security": [ + "security": [ + { + "api_key": [] + } + ] + } + }, + "/hazard/cancer-summary/search/by-dtxsid/{dtxsid}": { + "get": { + "tags": [ + "ToxValDB Cancer Summary Resource" + ], + "summary": "Get data by DTXSID", + "description": "return cancer summary data for requested DTXSID", + "operationId": "cancerSummaryByDtxsid", + "parameters": [ + { + "name": "dtxsid", + "in": "path", + "description": "DSSTox Substance Identifier", + "required": true, + "schema": { + "type": "string" + }, + "example": "DTXSID0021125" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "string", + "oneOf": [ { - "api_key": [] + "$ref": "#/components/schemas/CancerSummary" } - ] + ] + } + } } + } }, - "/hazard/adme-ivive/search/by-dtxsid/{dtxsid}": { - "get": { - "tags": [ - "ADME - IVIVE Resource" - ], - "summary": "Get ADME data for IVIVE by DTXSID with CCD projection", - "description": "return ADME data for requested DTXSID. There is an available projection aligned with what's available on the CCD ADME> IVIVE tab: ccd-adme-dataIf no projection is specified, the default ADME-IVIVE projection is returned", - "operationId": "admeDataByDtxsid", - "parameters": [ + "security": [ + { + "api_key": [] + } + ] + } + }, + "/hazard/adme-ivive/search/by-dtxsid/{dtxsid}": { + "get": { + "tags": [ + "ADME - IVIVE Resource" + ], + "summary": "Get ADME data for IVIVE by DTXSID with CCD projection", + "description": "return ADME data for requested DTXSID. There is an available projection aligned with what's available on the CCD ADME\u003E IVIVE tab: ccd-adme-dataIf no projection is specified, the default ADME-IVIVE projection is returned", + "operationId": "admeDataByDtxsid", + "parameters": [ + { + "name": "dtxsid", + "in": "path", + "description": "DSSTox Substance Identifier", + "required": true, + "schema": { + "type": "string" + }, + "example": "DTXSID7020182" + }, + { + "name": "projection", + "in": "query", + "description": "Specifies if projection is used. Option: ccd-adme-data. If omitted, the default ADME-IVIVE projection is returned.", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "string", + "oneOf": [ { - "name": "dtxsid", - "in": "path", - "description": "DSSTox Substance Identifier", - "required": true, - "schema": { - "type": "string" - }, - "example": "DTXSID7020182" + "$ref": "#/components/schemas/Adme" }, { - "name": "projection", - "in": "query", - "description": "Specifies if projection is used. Option: ccd-adme-data. If omitted, the default ADME-IVIVE projection is returned.", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "type": "string", - "oneOf": [ - { - "$ref": "#/components/schemas/Adme" - }, - { - "$ref": "#/components/schemas/CcdADME" - } - ] - } - } - } - } - }, - "security": [ - { - "api_key": [] + "$ref": "#/components/schemas/CcdADME" } - ] - } - } - }, - "components": { - "schemas": { - "ToxValDb": { - "type": "object", - "description": "The Toxicity Values Database (ToxValDB) is a compilation of toxicity information from world-wide sites, databases, and sources, which can save the user time by providing information in one location. The data are largely limited to summary values from individual studies or chemical-level assessments, and is focused on quantitative values such as LOAELs, NOAELs, BMDs, LD50s and RfDs. The user must apply judgment in use of the information and should consult the original scientific paper or data source, if possible, to ensure an understanding of the context of the data. The ToxValDB SQL download is available at https://www.epa.gov/comptox-tools/downloadable-computational-toxicology-data#AT .", - "properties": { - "id": { - "type": "integer", - "format": "int32" - }, - "dtxsid": { - "type": "string", - "description": "Distributed Structure-Searchable Toxicity (DSSTox) id", - "maxLength": 45, - "minLength": 0 - }, - "casrn": { - "type": "string" - }, - "name": { - "type": "string" - }, - "source": { - "type": "string", - "description": "Originator of source data", - "maxLength": 255, - "minLength": 0 - }, - "subsource": { - "type": "string", - "description": "Additional source reference", - "maxLength": 255, - "minLength": 0 - }, - "toxvalType": { - "type": "string", - "description": "Categorization of records based on POD or effect level. Categories include: Point of Departure (The quantitative result of an in vivo repeat dose study, such as a LOAEL, NOAEL or BMDL), Lethality Effect Level (The quantitative result of an in vivo acute study, such as a LD50 or LC50), Toxicity Value (A risk assessment summary value for a chemical, such as an RFD or cancer slope factor), Screening Level (An environmentally safe concentration, primarily EPA Regional Screening levels), Exposure Limit (Exposure levels of concern in air, water, or other media), Effect Time (A time when an effect is seen for a fixed concentration. These values all come from the ECOTOX Knowledgebase), Effect Level (A value similar to a Point of Departure, but not linked to a critical effect), Effect Dose (Similar to a Lethality Effect Level but for non-lethal ecotoxicology endpoints in acute studies), Inhibition Concentration (Similar to a Lethality Effect Level but for non-lethal ecotoxicology endpoints, focused on inhibition of growth), Other (Other uncharacterized classes of records)", - "maxLength": 255, - "minLength": 0 - }, - "toxvalTypeDefinition": { - "type": "string" - }, - "toxvalSubtype": { - "type": "string", - "description": "Effect subtype or value subtype", - "maxLength": 255, - "minLength": 0 - }, - "toxvalTypeSuperCategory": { - "type": "string", - "maxLength": 255, - "minLength": 0 - }, - "qualifier": { - "type": "string", - "description": "Operators (<, <=, >, >=, =) to contextualize level of certainty in estimates", - "maxLength": 255, - "minLength": 0 - }, - "toxvalNumeric": { - "type": "number", - "format": "double", - "description": "Concentration of a test chemical, typically reported in ppm within the exposure matrix (e.g., feed or water), or the an adjusted amount of the chemical administered in mg/kg of body weight/day (mg/kg/day)" - }, - "toxvalUnits": { - "type": "string", - "description": "Unit associated with the concentration or adjusted dose of a chemical", - "maxLength": 255, - "minLength": 0 - }, - "riskAssessmentClass": { - "type": "string", - "description": "Designation of cancer or non-cancer for toxicity values or media associated with exposure guideline values", - "maxLength": 255, - "minLength": 0 - }, - "humanEco": { - "type": "string", - "maxLength": 255, - "minLength": 0 - }, - "studyType": { - "type": "string", - "description": "Classification to describe toxicity testing that was conducted", - "maxLength": 255, - "minLength": 0 - }, - "studyDurationClass": { - "type": "string", - "description": "Categorical description of exposure duration ", - "maxLength": 255, - "minLength": 0 - }, - "studyDurationValue": { - "type": "number", - "format": "double", - "description": "Amount of time a group is dosed. This varies within studies depending on the dose period of a particular treatment group" - }, - "studyDurationUnits": { - "type": "string", - "description": "Unit of time associated with the dose duration. Typically in days or months", - "maxLength": 255, - "minLength": 0 - }, - "speciesCommon": { - "type": "string", - "description": "Species of the animal test subject used in a study", - "maxLength": 255, - "minLength": 0 - }, - "strain": { - "type": "string", - "description": "Intraspecific description of group of animals used in a study; generally, a stock of animals that share a uniform morphological or physiological character, or group that is genetically uniform", - "maxLength": 255, - "minLength": 0 - }, - "latinName": { - "type": "string", - "maxLength": 255, - "minLength": 0 - }, - "speciesSupercategory": { - "type": "string", - "description": "Categorization of effect or value type into one of five categories, including dose response summary value, mortality response summary value, toxicity value, media exposure guidelines, or acute exposure guidelines", - "maxLength": 255, - "minLength": 0 - }, - "sex": { - "type": "string", - "description": "Gender of a test animal. The gender of fetal groups is denoted as MF for both males and females", - "maxLength": 255, - "minLength": 0 - }, - "generation": { - "type": "string", - "description": "Generation a test animal belongs to", - "maxLength": 255, - "minLength": 0 - }, - "lifestage": { - "type": "string", - "description": "Stage of life that a measurement was taken", - "maxLength": 255, - "minLength": 0 - }, - "exposureRoute": { - "type": "string", - "description": "Path by which test substance was administered to animal. Options include oral, dermal, inhalation, injection, or other", - "maxLength": 255, - "minLength": 0 - }, - "exposureMethod": { - "type": "string", - "description": "Specific path by which the test substance was administered via the administration route. Examples include capsule, diet, gavage, or topical", - "maxLength": 255, - "minLength": 0 - }, - "exposureForm": { - "type": "string", - "description": "The vehicle used in administration of the chemical", - "maxLength": 255, - "minLength": 0 - }, - "media": { - "type": "string", - "maxLength": 255, - "minLength": 0 - }, - "toxicologicalEffect": { - "type": "string", - "description": "Treatment-associated effect " - }, - "experimentalRecord": { - "type": "string" - }, - "studyGroup": { - "type": "string", - "maxLength": 255, - "minLength": 0 - }, - "longRef": { - "type": "string" - }, - "doi": { - "type": "string" - }, - "title": { - "type": "string" - }, - "author": { - "type": "string", - "maxLength": 255, - "minLength": 0 - }, - "year": { - "type": "string", - "maxLength": 255, - "minLength": 0 - }, - "guideline": { - "type": "string", - "maxLength": 255, - "minLength": 0 - }, - "quality": { - "type": "string", - "maxLength": 255, - "minLength": 0 - }, - "qcCategory": { - "type": "string" - }, - "sourceHash": { - "type": "string", - "maxLength": 45, - "minLength": 0 - }, - "externalSourceId": { - "type": "string" - }, - "externalSourceIdDesc": { - "type": "string" - }, - "sourceUrl": { - "type": "string", - "description": "URL for source data", - "maxLength": 255, - "minLength": 0 - }, - "subsourceUrl": { - "type": "string", - "description": "Additional URL reference for source data", - "maxLength": 255, - "minLength": 0 - }, - "storedSourceRecord": { - "type": "string", - "maxLength": 255, - "minLength": 0 - }, - "toxvalTypeOriginal": { - "type": "string", - "description": "Categorization of records based on POD or effect level. Categories include: Point of Departure (The quantitative result of an in vivo repeat dose study, such as a LOAEL, NOAEL or BMDL), Lethality Effect Level (The quantitative result of an in vivo acute study, such as a LD50 or LC50), Toxicity Value (A risk assessment summary value for a chemical, such as an RFD or cancer slope factor), Screening Level (An environmentally safe concentration, primarily EPA Regional Screening levels), Exposure Limit (Exposure levels of concern in air, water, or other media), Effect Time (A time when an effect is seen for a fixed concentration. These values all come from the ECOTOX Knowledgebase), Effect Level (A value similar to a Point of Departure, but not linked to a critical effect), Effect Dose (Similar to a Lethality Effect Level but for non-lethal ecotoxicology endpoints in acute studies), Inhibition Concentration (Similar to a Lethality Effect Level but for non-lethal ecotoxicology endpoints, focused on inhibition of growth), Other (Other uncharacterized classes of records) (original)", - "maxLength": 255, - "minLength": 0 - }, - "toxvalSubtypeOriginal": { - "type": "string", - "description": "Effect subtype or value subtype (original)", - "maxLength": 255, - "minLength": 0 - }, - "toxvalNumericOriginal": { - "type": "number", - "format": "double", - "description": "Concentration of a test chemical, typically reported in ppm within the exposure matrix (e.g., feed or water), or the an adjusted amount of the chemical administered in mg/kg of body weight/day (mg/kg/day) (original)", - "maximum": 255, - "minimum": 0 - }, - "toxvalUnitsOriginal": { - "type": "string", - "description": "Unit associated with the concentration or adjusted dose of a chemical (original)", - "maxLength": 255, - "minLength": 0 - }, - "studyTypeOriginal": { - "type": "string", - "description": "Classification to describe toxicity testing that was conducted (original)", - "maxLength": 255, - "minLength": 0 - }, - "studyDurationClassOriginal": { - "type": "string", - "description": "Categorical description of exposure duration (original)", - "maxLength": 255, - "minLength": 0 - }, - "studyDurationValueOriginal": { - "type": "string", - "description": "Amount of time a group is dosed. This varies within studies depending on the dose period of a particular treatment group (original)", - "maxLength": 255, - "minLength": 0 - }, - "studyDurationUnitsOriginal": { - "type": "string", - "description": "Unit of time associated with the dose duration. Typically in days or months (original)", - "maxLength": 255, - "minLength": 0 - }, - "speciesOriginal": { - "type": "string", - "description": "Species of the animal test subject used in a study (original)", - "maxLength": 255, - "minLength": 0 - }, - "strainOriginal": { - "type": "string", - "description": "Intraspecific description of group of animals used in a study; generally, a stock of animals that share a uniform morphological or physiological character, or group that is genetically uniform (original)", - "maxLength": 255, - "minLength": 0 - }, - "sexOriginal": { - "type": "string", - "description": "Gender of a test animal. The gender of fetal groups is denoted as MF for both males and females (original)", - "maxLength": 255, - "minLength": 0 - }, - "generationOriginal": { - "type": "string", - "description": "Generation a test animal belongs to (original)", - "maxLength": 255, - "minLength": 0 - }, - "lifestageOriginal": { - "type": "string", - "description": "Stage of life that a measurement was taken (original)", - "maxLength": 255, - "minLength": 0 - }, - "exposureRouteOriginal": { - "type": "string", - "description": "Path by which test substance was administered to animal. Options include oral, dermal, inhalation, injection, or other (original)", - "maxLength": 255, - "minLength": 0 - }, - "exposureMethodOriginal": { - "type": "string", - "description": "Specific path by which the test substance was administered via the administration route. Examples include capsule, diet, gavage, or topical (original", - "maxLength": 255, - "minLength": 0 - }, - "exposureFormOriginal": { - "type": "string", - "description": "The vehicle used in administration of the chemical (original)", - "maxLength": 255, - "minLength": 0 - }, - "mediaOriginal": { - "type": "string", - "maxLength": 255, - "minLength": 0 - }, - "toxicologicalEffectOriginal": { - "type": "string", - "description": "Treatment-associated effect (original)" - }, - "originalYear": { - "type": "string", - "description": "Year in which the study was reported as finished", - "maxLength": 255, - "minLength": 0 - } - }, - "required": [ - "id" - ] - }, - "ProblemDetail": { - "type": "object", - "properties": { - "type": { - "type": "string", - "format": "uri" - }, - "title": { - "type": "string" - }, - "status": { - "type": "integer", - "format": "int32" - }, - "detail": { - "type": "string" - }, - "instance": { - "type": "string", - "format": "uri" - }, - "properties": { - "type": "object", - "additionalProperties": {} - } - } - }, - "ToxRefBatch": { - "type": "object", - "description": "Export of all extracted dose-treatment group-effect information as well as doses not eliciting effects from ToxRefDB for the dtxsids listed in the input. Data from ToxRefDB is also summarized in ToxValDB, including inferred NEL and NOAEL effect levels based on the reported LEL and LOAEL, respectively.", - "properties": { - "studyId": { - "type": "integer", - "format": "int32", - "description": "A unique numeric identifier for each study in the database." - }, - "dtxsid": { - "type": "string", - "description": "Unique identifier from DSSTox", - "maxLength": 45, - "minLength": 0 - }, - "casrn": { - "type": "string", - "description": "Curated casrn from DSSTOX chemical curation", - "maxLength": 255, - "minLength": 0 - }, - "name": { - "type": "string", - "description": "Curated chemical name from DSSTOX chemical curation", - "maxLength": 255, - "minLength": 0 - }, - "studySource": { - "type": "string", - "description": "Organization that provided or authored the document for curation.", - "maxLength": 255, - "minLength": 0 - }, - "studySourceId": { - "type": "string", - "description": "Unique document identifier provided by the study source.", - "maxLength": 255, - "minLength": 0 - }, - "citation": { - "type": "string", - "description": "Citation in source document", - "maxLength": 1024, - "minLength": 0 - }, - "studyYear": { - "type": "string" - }, - "studyType": { - "type": "string", - "description": "Classification to describe animal toxicity testing that was conducted. Based on either dose period, subjects involved, or measured effects of interest, study types include: ACU (acute): Dose period typically a day or less. Excludes developmental and neurological studies.; SAC (subacute): Dose period is typically 21-28 days. Excludes developmental and neurological studies.; SUB (subchronic): Dose period is typically 13 weeks, but may be as long as 6 months. Excludes developmental and neurological studies.; CHR (chronic): Dose period is typically 12, 18, or 24 months (generally any dosing lasting a year or longer). Excludes developmental and neurological studies.; DEV (developmental): Gestational (in utero) dose period. Sacrificed prior to delivery.; MGR (multigenerational reproductive): Dose period begins in adolescent F0 males and females and continues until terminal generation. At least some of the litters deliver their pups, some may be sacrificed prior to delivery.; NEU (neurological): Study contains functional observation battery or other battery of behavioral testing that occurs during or after dosing. Pathology has specific interest in the brain (i.e. regions, morphology, biochemistry, et cetera). excludes developmental studies; DNT (developmental neurotoxicity): dose period occurs anytime during development (i.e. in utero, lactational, adolescent [after weaning, before adulthood]). Study contains functional observation battery or other battery of behavioral testing that occurs during or after dosing, typically during adulthood. Pathology has specific interest in the brain (i.e. regions, morphology, biochemistry, etc.)", - "maxLength": 255, - "minLength": 0 - }, - "studyTypeGuideline": { - "type": "string", - "description": "Description that combines the study_type and guideline name for a study.", - "maxLength": 255, - "minLength": 0 - }, - "species": { - "type": "string", - "description": "Species of the animal test subject used in a study.", - "maxLength": 255, - "minLength": 0 - }, - "strainGroup": { - "type": "string", - "description": "Descriptive category for a group of test animals that is more general than the strain. ", - "maxLength": 255, - "minLength": 0 - }, - "strain": { - "type": "string", - "description": "Intraspecific description of group of animals used in a study; generally, a stock of animals that share a uniform morphological or physiological character, or group that is genetically uniform.", - "maxLength": 255, - "minLength": 0 - }, - "adminRoute": { - "type": "string", - "description": "Path by which test substance was administered to animal. Options include oral, dermal, inhalation, injection, or other.", - "maxLength": 255, - "minLength": 0 - }, - "adminMethod": { - "type": "string", - "description": "Specific path by which the test substance was administered via the administration route. Examples include capsule, diet, gavage, or topical.", - "maxLength": 255, - "minLength": 0 - }, - "doseDuration": { - "type": "string", - "description": "Amount of time a group is dosed. This varies within studies depending on the dose period of a particular treatment group." - }, - "doseDurationUnit": { - "type": "string", - "description": "Unit of time associated with the dose duration. Typically in days or months.", - "maxLength": 16, - "minLength": 0 - }, - "doseStart": { - "type": "integer", - "format": "int32", - "description": "Time during an animal's life that the administration of a test substance began." - }, - "doseStartUnit": { - "type": "string", - "description": "Unit of time associated with the start of the dose (dose_start).", - "maxLength": 255, - "minLength": 0 - }, - "doseEnd": { - "type": "integer", - "format": "int32", - "description": "Time during an animal's life that the administration of a test substance stopped." - }, - "doseEndUnit": { - "type": "string", - "description": "Unit of time associated with the end of the dose (dose_end).", - "maxLength": 255, - "minLength": 0 - }, - "dosePeriod": { - "type": "string", - "description": "Period within a group's lifetime that the animals were dosed and the sample for an endpoint's data was taken (when the animals were sacrificed).", - "maxLength": 32, - "minLength": 0 - }, - "doseLevel": { - "type": "integer", - "format": "int32", - "description": "Numeric rank indicating the level of dose administered to test animals, with lower dose levels indicating lower concentrations of a chemical (e.g., 0 = vehicle, 1 = lowest dose, etc.). The dose level for some studies may be staggered since concentrations may vary by sex (e.g, male treatment group: 0 = vehicle, 1 = lowest dose, 3 = second lowest dose, etc.)." - }, - "conc": { - "type": "string", - "description": "Concentration of a test chemical, typically reported in ppm within the exposure matrix (e.g., feed or water)." - }, - "concUnit": { - "type": "string", - "description": "Unit associated with a concentration of a test chemical, typically reported as ppm.", - "maxLength": 255, - "minLength": 0 - }, - "vehicle": { - "type": "string", - "description": "The media used in administration of the chemical.", - "maxLength": 255, - "minLength": 0 - }, - "doseComment": { - "type": "string", - "description": "NULL if no additional comment needed. Field can be used to explain any differences in dosing over the dosing interval and/or clarifying comments on how the dose was administered.", - "maxLength": 1024, - "minLength": 0 - }, - "doseAdjusted": { - "type": "string", - "description": "The amount of the chemical administered in mg/kg of body weight/day (mg/kg/day). This value is typically different between male and female groups receiving the same dose concentration (conc) due to differences in bodyweight. If dose_adjusted values were not provided in a study, then they were calculated using species scaling factors (FAO/WHO, 2000)." - }, - "doseAdjustedUnit": { - "type": "string", - "description": "Unit associated with the adjusted dose of a chemical, typically reported in mg/kg/day.", - "maxLength": 32, - "minLength": 0 - }, - "sex": { - "type": "string", - "description": "Gender of a test animal. The gender of fetal groups is denoted as MF for both males and females.", - "maxLength": 8, - "minLength": 0 - }, - "generation": { - "type": "string", - "description": "Generation a test animal belongs to. The F0 generation is the first generation mating group for MGR studies and is the default for non-reproductive studies (CHR, SUB, SAC). F1 is the second generation mating group, selected from either F1a or F1b litters. F2 is the third generation mating group, selected from either F2a or F2b litters. F1a and F1b are the first and second litter groups produced by F0 matings, F2a and F2b are the first and second litter groups produced by F1 matings, and F3a and F3b are the first and second litter groups produced by F2 matings. The fetal generation is the group produced by F0 matings in DEV studies, and are typically removed from a female via cesarean section in DEV studies.", - "maxLength": 16, - "minLength": 0 - }, - "lifeStage": { - "type": "string", - "description": "Stage of life that a measurement was taken. CHR, SUB, and SAC studies typically only have adult for life_stage, whereas DEV and MGR studies will always be characterized by multiple life stages. The different life stages in the database include: fetal, juvenile, adult, adult-pregnancy and pregnancy.", - "maxLength": 32, - "minLength": 0 - }, - "numAnimals": { - "type": "string", - "description": "Number of animals per treatment group", - "maxLength": 255, - "minLength": 0 - }, - "tgComment": { - "type": "string", - "description": "NULL if no additional comment needed; contains information that the extractor/curator found helpful in describing issues related to a treatment-group (e.g. animals dosed via capsule so concentration not reported, added recovery groups, etc.). ", - "maxLength": 1024, - "minLength": 0 - }, - "endpointCategory": { - "type": "string", - "description": "The broadest descriptive term for an endpoint. Possible endpoint categories include: systemic, developmental, reproductive, and cholinesterase.", - "maxLength": 255, - "minLength": 0 - }, - "endpointType": { - "type": "string", - "description": "The subcategory for endpoint_category, which is more descriptive for a particular endpoint (e.g. pathology gross, clinical chemistry, reproductive performance, etc.)", - "maxLength": 255, - "minLength": 0 - }, - "endpointTarget": { - "type": "string", - "description": "More specific description than endpoint_type, often indicating where or how the sample was collected to supply data for a particular endpoint. Target may describe an organ, tissue, metabolite or protein measured.", - "maxLength": 255, - "minLength": 0 - }, - "effectDesc": { - "type": "string", - "description": "More specific description for an effect than endpoint_category, usually detailing a specific condition associated with an endpoint_target (e.g. dysplasia, atrophy, necrosis, etc.).", - "maxLength": 255, - "minLength": 0 - }, - "effectDescFree": { - "type": "string", - "description": "Brief verbatim text from study file that was entered if the effect description differed from predetermined endpoint terminology.", - "maxLength": 255, - "minLength": 0 - }, - "cancerRelated": { - "type": "boolean", - "description": "Indicates if effect is considered cancer related (1) or not." - }, - "targetSite": { - "type": "string", - "description": "A more specific description than effect_target. Can describe a specific tissue within an organ, type of cell, etc.", - "maxLength": 64, - "minLength": 0 - }, - "direction": { - "type": "integer", - "format": "int32", - "description": "Description of the net change across all doses that indicates whether the numerical data increased, decreased, or stayed the same. Also can be used to describe effects that did not have numerical data, but were still described in the study source." - }, - "effectComment": { - "type": "string", - "description": "NULL if no additional comment needed; contains information that the extractor/curator found helpful in describing issues related to a treatment-group-effect (e.g. units not reported, effect only reported for certain treatment groups, etc.).", - "maxLength": 1024, - "minLength": 0 - }, - "treatmentRelated": { - "type": "string", - "description": "Boolean description for an effect by dose treatment group. “TRUE” indicates there was a statistically significant difference from the control group for the effect; “FALSE” indicates there was no difference from control group. The highest dose level at which no significant observable adverse effects were observed corresponds to the no effect level (NEL). The lowest effect level (LEL) can be inferred by treatment related effects." - }, - "criticalEffect": { - "type": "boolean", - "description": "Boolean description for an effect by dose treatment group. “TRUE” corresponds to a toxic or adverse effect denoted in the study summary or via expert judgement using a weight-of-evidence approach. “FALSE” indicates that although an effect is produced at this level, it is not considered adverse, nor immediate precursors to specific adverse effects. If there are several critical effects, the no observed adverse effect level (NOAEL) is determined from the highest dose level without critical effects. The lowest dose level at which the critical effect was observed in a study is the lowest observed adverse effect level (LOAEL.)" - }, - "sampleSize": { - "type": "string", - "description": "Number of animals used for an examination for a particular effect.", - "maxLength": 8, - "minLength": 0 - }, - "effectVal": { - "type": "string", - "description": "Numeric value of a measured effect, can be continuous or dichotomous (incidence) data." - }, - "effectValUnit": { - "type": "string", - "description": "Unit associated with the effect value.", - "maxLength": 128, - "minLength": 0 - }, - "effectVar": { - "type": "string", - "description": "Measurement of the variance for a set of data associated with a measured effect, generally reported as the standard deviation (SD) or standard error (SE)." - }, - "effectVarType": { - "type": "string", - "description": "Name of the variance metric used to determine the effect variance, typically the standard deviation (SD) or standard error (SE). Other effect_var types include: interquartile range, 95% confidence limit, and none.", - "maxLength": 32, - "minLength": 0 - }, - "time": { - "type": "string", - "description": "Numeric value associated with the duration of the exposure at which a particular effect was measured or observed, typically reported in hours, days, weeks, or months." - }, - "timeUnit": { - "type": "string", - "description": " Unit associated with the duration of the exposure at which a particular effect was measured or observed, typically reported in hours, days, weeks, or months.", - "maxLength": 64, - "minLength": 0 - }, - "noQuantDataReported": { - "type": "boolean", - "description": "Indicates if qualitative (1) or quantitative (0) effect data was reported." - }, - "tbsKey": { - "type": "integer", - "format": "int64", - "description": "Date view of ToxRefDB data was created for API" - } - } - }, - "SkinEye": { - "type": "object", - "description": "Skin and eye irritation tests are used to assess the safety of products and chemicals that may come into contact with the skin or eyes. These tests are important for labeling and registering chemicals and agrochemicals, and for developing drugs. Types of skin and eye irritation tests include Draize test, EpiOcular Eye Irritation Test (EIT), Red blood cells test, or Patch test", - "properties": { - "id": { - "type": "integer", - "format": "int32" - }, - "authority": { - "type": "string", - "maxLength": 45, - "minLength": 0 - }, - "classification": { - "type": "string", - "description": "Classification into hazard categories based on the severity of the skin or eye irritation", - "maxLength": 255, - "minLength": 0 - }, - "dtxsid": { - "type": "string", - "description": "Distributed Structure-Searchable Toxicity (DSSTox) id ", - "maxLength": 255, - "minLength": 0 - }, - "endpoint": { - "type": "string", - "description": "Skin sensitization or eye irritation", - "maxLength": 255, - "minLength": 0 - }, - "glp": { - "type": "string" - }, - "guideline": { - "type": "string", - "description": "Number associated with the particular guideline that a test adheres to or most closely adheres to" - }, - "recordUrl": { - "type": "string", - "maxLength": 1024, - "minLength": 0 - }, - "reliability": { - "type": "string", - "description": "Ranking of reliability of results", - "maxLength": 45, - "minLength": 0 - }, - "resultText": { - "type": "string", - "description": "Annotation describing results", - "maxLength": 1024, - "minLength": 0 - }, - "score": { - "type": "string", - "description": "Hazard scoring based on classification", - "maxLength": 45, - "minLength": 0 - }, - "skinEyeHash": { - "type": "string", - "maxLength": 255, - "minLength": 0 - }, - "skinEyeId": { - "type": "integer", - "format": "int32" - }, - "skinEyeUuid": { - "type": "string", - "maxLength": 255, - "minLength": 0 - }, - "source": { - "type": "string", - "description": "Originator of source data", - "maxLength": 45, - "minLength": 0 - }, - "species": { - "type": "string", - "description": "Species of the animal test subject used in a study", - "maxLength": 255, - "minLength": 0 - }, - "strain": { - "type": "string", - "description": "Intraspecific description of group of animals used in a study; generally, a stock of animals that share a uniform morphological or physiological character, or group that is genetically uniform", - "maxLength": 255, - "minLength": 0 - }, - "studyType": { - "type": "string", - "description": "Classification to describe testing that was conducted", - "maxLength": 255, - "minLength": 0 - }, - "year": { - "type": "integer", - "format": "int32", - "description": "Year in which the study was reported as finished" - } - }, - "required": [ - "id" - ] - }, - "GenetoxSummary": { - "type": "object", - "description": "Description: Genotoxicity testing, also known as short-term assays, is used to evaluate the potential adverse effects of chemicals on human health. These tests can help identify carcinogens, as about 80% of known human carcinogens are genotoxic. The results of genotoxicity tests are important because of the irreversible nature and severity of the health effects that may result from genotoxic events. There are many different techniques that can be used for genotoxicity testing, notably including Ames test (comparative genetic analysis using multiple bacterial strains of Salmonella typhimurium), Comet assay (measurement DNA strand breaks), micronucleus test (cytogenetic assay that uses fluorescence in situ hybridization and chromosome painting) and chromosomal aberration test (cytogenetic assay that examines in vivo tissues to reflect how chemicals are absorbed, excreted, distributed, and metabolized). This endpoint provides summary-level genotoxicity data associated to a chemical.", - "properties": { - "id": { - "type": "integer", - "format": "int32" - }, - "ames": { - "type": "string", - "description": "Average result in AMES test", - "maxLength": 255, - "minLength": 0 - }, - "clowderDocId": { - "type": "string", - "maxLength": 65, - "minLength": 0 - }, - "dtxsid": { - "type": "string", - "description": "Distributed Structure-Searchable Toxicity (DSSTox) id", - "maxLength": 255, - "minLength": 0 - }, - "genetoxCall": { - "type": "string", - "maxLength": 255, - "minLength": 0 - }, - "genetoxSummaryId": { - "type": "integer", - "format": "int32" - }, - "micronucleus": { - "type": "string", - "description": "Average result in Micronucleus test", - "maxLength": 255, - "minLength": 0 - }, - "reportsNegative": { - "type": "integer", - "format": "int32", - "description": "Count of genetox records reporting negative results" - }, - "reportsOther": { - "type": "integer", - "format": "int32", - "description": "Count of genetox records reporting ‘other’ in results" - }, - "reportsPositive": { - "type": "integer", - "format": "int32", - "description": "Count of genetox records reporting positive results" - } - }, - "required": [ - "id" - ] - }, - "GenetoxDetail": { - "type": "object", - "description": "Description: Genotoxicity testing, also known as short-term assays, is used to evaluate the potential adverse effects of chemicals on human health. These tests can help identify carcinogens, as about 80% of known human carcinogens are genotoxic. The results of genotoxicity tests are important because of the irreversible nature and severity of the health effects that may result from genotoxic events. There are many different techniques that can be used for genotoxicity testing, notably including Ames test (comparative genetic analysis using multiple bacterial strains of Salmonella typhimurium), Comet assay (measurement DNA strand breaks), micronucleus test (cytogenetic assay that uses fluorescence in situ hybridization and chromosome painting) and chromosomal aberration test (cytogenetic assay that examines in vivo tissues to reflect how chemicals are absorbed, excreted, distributed, and metabolized). This endpoint provides detailed genotoxicity data associated to a chemical.", - "properties": { - "id": { - "type": "integer", - "format": "int32" - }, - "assayCategory": { - "type": "string", - "description": "Category of assay: in vitro or in vivo", - "maxLength": 45, - "minLength": 0 - }, - "assayCode": { - "type": "string", - "maxLength": 45, - "minLength": 0 - }, - "assayPotency": { - "type": "integer", - "format": "int32", - "maximum": 45, - "minimum": 0 - }, - "assayResult": { - "type": "string", - "description": "Result in assay (positive, negative, or other)", - "maxLength": 45, - "minLength": 0 - }, - "assayType": { - "type": "string", - "description": "Type of genotoxicity assay", - "maxLength": 255, - "minLength": 0 - }, - "assayTypeStandard": { - "type": "string", - "maxLength": 255, - "minLength": 0 - }, - "chemicalId": { - "type": "string", - "maxLength": 255, - "minLength": 0 - }, - "clowderDocId": { - "type": "string", - "maxLength": 65, - "minLength": 0 - }, - "comment": { - "type": "string" - }, - "cytotoxicity": { - "type": "string", - "maxLength": 255, - "minLength": 0 - }, - "dataQuality": { - "type": "integer", - "format": "int32", - "maximum": 45, - "minimum": 0 - }, - "documentNumber": { - "type": "integer", - "format": "int32", - "maximum": 45, - "minimum": 0 - }, - "documentSource": { - "type": "string", - "maxLength": 45, - "minLength": 0 - }, - "doseResponse": { - "type": "string", - "maxLength": 45, - "minLength": 0 - }, - "dtxsid": { - "type": "string", - "description": "Distributed Structure-Searchable Toxicity (DSSTox) id", - "maxLength": 255, - "minLength": 0 - }, - "duration": { - "type": "integer", - "format": "int32", - "maximum": 45, - "minimum": 0 - }, - "genetoxCall": { - "type": "string", - "maxLength": 255, - "minLength": 0 - }, - "genetoxDetailsId": { - "type": "integer", - "format": "int32" - }, - "genetoxNote": { - "type": "string", - "maxLength": 255, - "minLength": 0 - }, - "genetoxResults": { - "type": "string", - "maxLength": 255, - "minLength": 0 - }, - "genetoxSummaryId": { - "type": "integer", - "format": "int32" - }, - "glp": { - "type": "integer", - "format": "int32" - }, - "guideline": { - "type": "string" - }, - "index": { - "type": "string" - }, - "metabolicActivation": { - "type": "string", - "description": "Indicator if assay included metabolic activation", - "maxLength": 45, - "minLength": 0 - }, - "micronucleus": { - "type": "string" - }, - "panelReport": { - "type": "string", - "maxLength": 255, - "minLength": 0 - }, - "protocolEra": { - "type": "string", - "maxLength": 45, - "minLength": 0 - }, - "reference": { - "type": "string", - "maxLength": 1024, - "minLength": 0 - }, - "referenceUrl": { - "type": "string", - "maxLength": 255, - "minLength": 0 - }, - "reportsNeg": { - "type": "string" - }, - "reportsOther": { - "type": "string" - }, - "reportsPos": { - "type": "string" - }, - "sex": { - "type": "string", - "maxLength": 45, - "minLength": 0 - }, - "source": { - "type": "string", - "description": "Originator of source data", - "maxLength": 45, - "minLength": 0 - }, - "species": { - "type": "string", - "description": "Species of the animal test subject used in a study", - "maxLength": 45, - "minLength": 0 - }, - "strain": { - "type": "string", - "description": "Intraspecific description of group of animals used in a study; generally, a stock of animals that share a uniform morphological or physiological character, or group that is genetically uniform", - "maxLength": 255, - "minLength": 0 - }, - "title": { - "type": "string", - "maxLength": 1024, - "minLength": 0 - }, - "useme": { - "type": "integer", - "format": "int64", - "description": "Year in which the study was reported as finished" - }, - "year": { - "type": "integer", - "format": "int32", - "description": "Year in which the study was reported as finished" - } - }, - "required": [ - "id" - ] - }, - "CancerSummary": { - "type": "object", - "description": "A carcinogen is a substance that may cause cancer and pose a health hazard. Carcinogens are subject to specific controls and regulations. National and international health agencies evaluate new and existing chemicals to determine if they are likely to be carcinogens through a process called cancer hazard identification. This process combines human and animal data with supporting evidence to characterize the weight-of-evidence (WOE) regarding the agent's potential as a human carcinogen. The general categories recognized by the guidelines are carcinogenic to humans, likely to be carcinogenic to humans, and suggestive evidence of carcinogenic potential. This endpoint provides summary-level cancer data associated to a chemical.", - "properties": { - "id": { - "type": "integer", - "format": "int32" - }, - "dtxsid": { - "type": "string", - "description": "Distributed Structure-Searchable Toxicity (DSSTox) id", - "maxLength": 255, - "minLength": 0 - }, - "source": { - "type": "string", - "description": "Originator of source data", - "maxLength": 255, - "minLength": 0 - }, - "exposureRoute": { - "type": "string", - "description": "Path by which test substance was administered to animal. Options include oral, dermal, inhalation, injection, or other", - "maxLength": 255, - "minLength": 0 - }, - "cancerCall": { - "type": "string", - "description": "Annotation indicating level of carcinogenicity", - "maxLength": 255, - "minLength": 0 - }, - "url": { - "type": "string", - "description": "URL for source data", - "maxLength": 255, - "minLength": 0 - } - }, - "required": [ - "id" - ] - }, - "ToxRefSummary": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "studyId": { - "type": "integer", - "format": "int32", - "description": "A unique numeric identifier for each study in the database." - }, - "dtxsid": { - "type": "string", - "description": "Unique identifier from DSSTox", - "maxLength": 45, - "minLength": 0 - }, - "casrn": { - "type": "string", - "description": "Curated casrn from DSSTOX chemical curation", - "maxLength": 255, - "minLength": 0 - }, - "name": { - "type": "string", - "description": "Curated chemical name from DSSTOX chemical curation", - "maxLength": 255, - "minLength": 0 - }, - "studySource": { - "type": "string", - "description": "Organization that provided or authored the document for curation.", - "maxLength": 255, - "minLength": 0 - }, - "studySourceId": { - "type": "string", - "description": "Unique document identifier provided by the study source.", - "maxLength": 255, - "minLength": 0 - }, - "citation": { - "type": "string", - "description": "Citation in source document", - "maxLength": 1024, - "minLength": 0 - }, - "studyYear": { - "type": "integer", - "format": "int32" - }, - "studyType": { - "type": "string", - "description": "Classification to describe animal toxicity testing that was conducted. Based on either dose period, subjects involved, or measured effects of interest, study types include: ACU (acute): Dose period typically a day or less. Excludes developmental and neurological studies.; SAC (subacute): Dose period is typically 21-28 days. Excludes developmental and neurological studies.; SUB (subchronic): Dose period is typically 13 weeks, but may be as long as 6 months. Excludes developmental and neurological studies.; CHR (chronic): Dose period is typically 12, 18, or 24 months (generally any dosing lasting a year or longer). Excludes developmental and neurological studies.; DEV (developmental): Gestational (in utero) dose period. Sacrificed prior to delivery.; MGR (multigenerational reproductive): Dose period begins in adolescent F0 males and females and continues until terminal generation. At least some of the litters deliver their pups, some may be sacrificed prior to delivery.; NEU (neurological): Study contains functional observation battery or other battery of behavioral testing that occurs during or after dosing. Pathology has specific interest in the brain (i.e. regions, morphology, biochemistry, et cetera). excludes developmental studies; DNT (developmental neurotoxicity): dose period occurs anytime during development (i.e. in utero, lactational, adolescent [after weaning, before adulthood]). Study contains functional observation battery or other battery of behavioral testing that occurs during or after dosing, typically during adulthood. Pathology has specific interest in the brain (i.e. regions, morphology, biochemistry, etc.)", - "maxLength": 255, - "minLength": 0 - }, - "studyTypeGuideline": { - "type": "string", - "description": "Description that combines the study_type and guideline name for a study.", - "maxLength": 255, - "minLength": 0 - }, - "species": { - "type": "string", - "description": "Species of the animal test subject used in a study.", - "maxLength": 255, - "minLength": 0 - }, - "strainGroup": { - "type": "string", - "description": "Descriptive category for a group of test animals that is more general than the strain. ", - "maxLength": 255, - "minLength": 0 - }, - "strain": { - "type": "string", - "description": "Intraspecific description of group of animals used in a study; generally, a stock of animals that share a uniform morphological or physiological character, or group that is genetically uniform.", - "maxLength": 255, - "minLength": 0 - }, - "adminRoute": { - "type": "string", - "description": "Path by which test substance was administered to animal. Options include oral, dermal, inhalation, injection, or other.", - "maxLength": 255, - "minLength": 0 - }, - "adminMethod": { - "type": "string", - "description": "Specific path by which the test substance was administered via the administration route. Examples include capsule, diet, gavage, or topical.", - "maxLength": 255, - "minLength": 0 - }, - "doseStart": { - "type": "integer", - "format": "int32", - "description": "Time during an animal's life that the administration of a test substance began." - }, - "doseStartUnit": { - "type": "string", - "description": "Unit of time associated with the start of the dose (dose_start).", - "maxLength": 255, - "minLength": 0 - }, - "doseEnd": { - "type": "integer", - "format": "int32", - "description": "Time during an animal's life that the administration of a test substance stopped." - }, - "doseEndUnit": { - "type": "string", - "description": "Unit of time associated with the end of the dose (dose_end).", - "maxLength": 255, - "minLength": 0 - }, - "exportDate": { - "type": "string", - "format": "date", - "description": "Date view of ToxRefDB data was created for API" - }, - "version": { - "type": "string", - "description": "Version of ToxRefDB data" - } - }, - "required": [ - "id" - ] - }, - "ToxRefObs": { - "type": "object", - "description": "Export of all observations and endpoint observation status according to a relevant guideline profile for the chemicals, studies, or study types listed in the input. Given ToxRefDB curations are guideline studies with specific testing requirements, guideline profiles are used to populate a list of observations that should be reported and tested within the study, i.e. endpoint observation status. Endpoint Observation status enables automated distinction of true negatives (i.e. tested with no effect observed) and better understanding of false negative (i.e. missing) effects.", - "properties": { - "id": { - "type": "integer", - "format": "int32" - }, - "studyId": { - "type": "integer", - "format": "int32", - "description": "Autoincremented unique numeric identifier for each study in ToxRefDB" - }, - "dtxsid": { - "type": "string", - "description": "Identifier assigned through DSSTox chemical curation", - "maxLength": 45, - "minLength": 0 - }, - "casrn": { - "type": "string", - "description": "Curated casrn from DSSTOX chemical curation", - "maxLength": 255, - "minLength": 0 - }, - "name": { - "type": "string", - "description": "Curated chemical name from DSSTOX chemical curation", - "maxLength": 255, - "minLength": 0 - }, - "studyType": { - "type": "string", - "description": "Classification to describe animal toxicity testing that was conducted. Based on either dose period, subjects involved, or measured effects of interest, study types include: ACU (acute): Dose period typically a day or less. Excludes developmental and neurological studies.; SAC (subacute): Dose period is typically 21-28 days. Excludes developmental and neurological studies.; SUB (subchronic): Dose period is typically 13 weeks, but may be as long as 6 months. Excludes developmental and neurological studies.; CHR (chronic): Dose period is typically 12, 18, or 24 months (generally any dosing lasting a year or longer). Excludes developmental and neurological studies.; DEV (developmental): Gestational (in utero) dose period. Sacrificed prior to delivery.; MGR (multigenerational reproductive): Dose period begins in adolescent F0 males and females and continues until terminal generation. At least some of the litters deliver their pups, some may be sacrificed prior to delivery.; NEU (neurological): Study contains functional observation battery or other battery of behavioral testing that occurs during or after dosing. Pathology has specific interest in the brain (i.e. regions, morphology, biochemistry, et cetera). excludes developmental studies; DNT (developmental neurotoxicity): dose period occurs anytime during development (i.e. in utero, lactational, adolescent [after weaning, before adulthood]). Study contains functional observation battery or other battery of behavioral testing that occurs during or after dosing, typically during adulthood. Pathology has specific interest in the brain (i.e. regions, morphology, biochemistry, etc.)", - "maxLength": 255, - "minLength": 0 - }, - "guidelineNumber": { - "type": "string", - "description": "Number associated with the guideline.OPP DERs follow the Series 870 - Health Effects Test Guidelines.", - "maxLength": 64, - "minLength": 0 - }, - "guidelineName": { - "type": "string", - "description": "Name of guideline, such as the particular Office of Chemical Safety and Pollution Prevention (OCSPP) guideline or NTP specifications.", - "maxLength": 512, - "minLength": 0 - }, - "endpointCategory": { - "type": "string", - "description": "The broadest descriptive term for an endpoint. Possible endpoint categories include: systemic, developmental, reproductive, and cholinesterase.", - "maxLength": 255, - "minLength": 0 - }, - "endpointType": { - "type": "string", - "description": "The subcategory for endpoint_category, which is more descriptive for a particular endpoint (e.g. pathology gross, clinical chemistry, reproductive performance, etc.)", - "maxLength": 255, - "minLength": 0 - }, - "endpointTarget": { - "type": "string", - "description": "More specific description than endpoint_type, often indicating where or how the sample was collected to supply data for a particular endpoint. Target may describe an organ, tissue, metabolite or protein measured.", - "maxLength": 255, - "minLength": 0 - }, - "status": { - "type": "string", - "description": "The status regarding whether or not an endpoint was required, recommended, triggered, not required, or mentioned by the study's most closely related guideline. Assumes that an endpoint was tested if the guideline the study adheres to requires that endpoint to be tested.", - "maxLength": 64, - "minLength": 0 - }, - "defaultStatus": { - "type": "boolean", - "description": "The status regarding whether or not an endpoint was tested and reported in a study. Assumes that an endpoint was tested if the guideline the study adheres to requires that endpoint to be tested." - }, - "testedStatus": { - "type": "boolean", - "description": "Indicates if an endpoint was tested (1) or not tested (0). If an endpoint was tested, it was examined or measured in the study." - }, - "reportedStatus": { - "type": "boolean", - "description": "Indicates if an endpoint was reported (1) or not reported (0). If an endpoint was reported, it appears somewhere in the text of the report." - }, - "exportDate": { - "type": "string", - "format": "date", - "description": "Date view of ToxRefDB data was created for API" - }, - "version": { - "type": "string", - "description": "Version of ToxRefDB data" - } - }, - "required": [ - "id" - ] - }, - "ToxRefEffects": { - "type": "object", - "description": "Export of all extracted dose-treatment group-effect information from ToxRefDB for the chemicals, studies, or study types listed in the input. This view is available as an enhanced data sheet from batch search on the CompTox Chemicals Dashboard. Data from ToxRefDB is also summarized in ToxValDB, including inferred NEL and NOAEL effect levels based on the reported LEL and LOAEL, respectively.", - "properties": { - "id": { - "type": "integer", - "format": "int32" - }, - "studyId": { - "type": "integer", - "format": "int32", - "description": "A unique numeric identifier for each study in the database." - }, - "dtxsid": { - "type": "string", - "description": "Unique identifier from DSSTox", - "maxLength": 45, - "minLength": 0 - }, - "casrn": { - "type": "string", - "description": "Curated casrn from DSSTOX chemical curation", - "maxLength": 255, - "minLength": 0 - }, - "name": { - "type": "string", - "description": "Curated chemical name from DSSTOX chemical curation", - "maxLength": 255, - "minLength": 0 - }, - "studySource": { - "type": "string", - "description": "Organization that provided or authored the document for curation.", - "maxLength": 255, - "minLength": 0 - }, - "studySourceId": { - "type": "string", - "description": "Unique document identifier provided by the study source.", - "maxLength": 255, - "minLength": 0 - }, - "citation": { - "type": "string", - "description": "Citation in source document", - "maxLength": 1024, - "minLength": 0 - }, - "studyYear": { - "type": "integer", - "format": "int32" - }, - "studyType": { - "type": "string", - "description": "Classification to describe animal toxicity testing that was conducted. Based on either dose period, subjects involved, or measured effects of interest, study types include: ACU (acute): Dose period typically a day or less. Excludes developmental and neurological studies.; SAC (subacute): Dose period is typically 21-28 days. Excludes developmental and neurological studies.; SUB (subchronic): Dose period is typically 13 weeks, but may be as long as 6 months. Excludes developmental and neurological studies.; CHR (chronic): Dose period is typically 12, 18, or 24 months (generally any dosing lasting a year or longer). Excludes developmental and neurological studies.; DEV (developmental): Gestational (in utero) dose period. Sacrificed prior to delivery.; MGR (multigenerational reproductive): Dose period begins in adolescent F0 males and females and continues until terminal generation. At least some of the litters deliver their pups, some may be sacrificed prior to delivery.; NEU (neurological): Study contains functional observation battery or other battery of behavioral testing that occurs during or after dosing. Pathology has specific interest in the brain (i.e. regions, morphology, biochemistry, et cetera). excludes developmental studies; DNT (developmental neurotoxicity): dose period occurs anytime during development (i.e. in utero, lactational, adolescent [after weaning, before adulthood]). Study contains functional observation battery or other battery of behavioral testing that occurs during or after dosing, typically during adulthood. Pathology has specific interest in the brain (i.e. regions, morphology, biochemistry, etc.)", - "maxLength": 255, - "minLength": 0 - }, - "studyTypeGuideline": { - "type": "string", - "description": "Description that combines the study_type and guideline name for a study.", - "maxLength": 255, - "minLength": 0 - }, - "species": { - "type": "string", - "description": "Species of the animal test subject used in a study.", - "maxLength": 255, - "minLength": 0 - }, - "strainGroup": { - "type": "string", - "description": "Descriptive category for a group of test animals that is more general than the strain. ", - "maxLength": 255, - "minLength": 0 - }, - "strain": { - "type": "string", - "description": "Intraspecific description of group of animals used in a study; generally, a stock of animals that share a uniform morphological or physiological character, or group that is genetically uniform.", - "maxLength": 255, - "minLength": 0 - }, - "adminRoute": { - "type": "string", - "description": "Path by which test substance was administered to animal. Options include oral, dermal, inhalation, injection, or other.", - "maxLength": 255, - "minLength": 0 - }, - "adminMethod": { - "type": "string", - "description": "Specific path by which the test substance was administered via the administration route. Examples include capsule, diet, gavage, or topical.", - "maxLength": 255, - "minLength": 0 - }, - "doseDuration": { - "type": "integer", - "format": "int32", - "description": "Amount of time a group is dosed. This varies within studies depending on the dose period of a particular treatment group." - }, - "doseDurationUnit": { - "type": "string", - "description": "Unit of time associated with the dose duration. Typically in days or months.", - "maxLength": 16, - "minLength": 0 - }, - "doseStart": { - "type": "integer", - "format": "int32", - "description": "Time during an animal's life that the administration of a test substance began." - }, - "doseStartUnit": { - "type": "string", - "description": "Unit of time associated with the start of the dose (dose_start).", - "maxLength": 255, - "minLength": 0 - }, - "doseEnd": { - "type": "integer", - "format": "int32", - "description": "Time during an animal's life that the administration of a test substance stopped." - }, - "doseEndUnit": { - "type": "string", - "description": "Unit of time associated with the end of the dose (dose_end).", - "maxLength": 255, - "minLength": 0 - }, - "dosePeriod": { - "type": "string", - "description": "Period within a group's lifetime that the animals were dosed and the sample for an endpoint's data was taken (when the animals were sacrificed).", - "maxLength": 32, - "minLength": 0 - }, - "doseLevel": { - "type": "integer", - "format": "int32", - "description": "Numeric rank indicating the level of dose administered to test animals, with lower dose levels indicating lower concentrations of a chemical (e.g., 0 = vehicle, 1 = lowest dose, etc.). The dose level for some studies may be staggered since concentrations may vary by sex (e.g, male treatment group: 0 = vehicle, 1 = lowest dose, 3 = second lowest dose, etc.)." - }, - "conc": { - "type": "number", - "format": "double", - "description": "Concentration of a test chemical, typically reported in ppm within the exposure matrix (e.g., feed or water)." - }, - "concUnit": { - "type": "string", - "description": "Unit associated with a concentration of a test chemical, typically reported as ppm.", - "maxLength": 255, - "minLength": 0 - }, - "vehicle": { - "type": "string", - "description": "The media used in administration of the chemical.", - "maxLength": 255, - "minLength": 0 - }, - "doseComment": { - "type": "string", - "description": "NULL if no additional comment needed. Field can be used to explain any differences in dosing over the dosing interval and/or clarifying comments on how the dose was administered.", - "maxLength": 1024, - "minLength": 0 - }, - "doseAdjusted": { - "type": "number", - "description": "The amount of the chemical administered in mg/kg of body weight/day (mg/kg/day). This value is typically different between male and female groups receiving the same dose concentration (conc) due to differences in bodyweight. If dose_adjusted values were not provided in a study, then they were calculated using species scaling factors (FAO/WHO, 2000)." - }, - "doseAdjustedUnit": { - "type": "string", - "description": "Unit associated with the adjusted dose of a chemical, typically reported in mg/kg/day.", - "maxLength": 32, - "minLength": 0 - }, - "sex": { - "type": "string", - "description": "Gender of a test animal. The gender of fetal groups is denoted as MF for both males and females.", - "maxLength": 8, - "minLength": 0 - }, - "generation": { - "type": "string", - "description": "Generation a test animal belongs to. The F0 generation is the first generation mating group for MGR studies and is the default for non-reproductive studies (CHR, SUB, SAC). F1 is the second generation mating group, selected from either F1a or F1b litters. F2 is the third generation mating group, selected from either F2a or F2b litters. F1a and F1b are the first and second litter groups produced by F0 matings, F2a and F2b are the first and second litter groups produced by F1 matings, and F3a and F3b are the first and second litter groups produced by F2 matings. The fetal generation is the group produced by F0 matings in DEV studies, and are typically removed from a female via cesarean section in DEV studies.", - "maxLength": 16, - "minLength": 0 - }, - "lifeStage": { - "type": "string", - "description": "Stage of life that a measurement was taken. CHR, SUB, and SAC studies typically only have adult for life_stage, whereas DEV and MGR studies will always be characterized by multiple life stages. The different life stages in the database include: fetal, juvenile, adult, adult-pregnancy and pregnancy.", - "maxLength": 32, - "minLength": 0 - }, - "numAnimals": { - "type": "number", - "description": "Number of animals per treatment group" - }, - "tgComment": { - "type": "string", - "description": "NULL if no additional comment needed; contains information that the extractor/curator found helpful in describing issues related to a treatment-group (e.g. animals dosed via capsule so concentration not reported, added recovery groups, etc.). ", - "maxLength": 1024, - "minLength": 0 - }, - "endpointCategory": { - "type": "string", - "description": "The broadest descriptive term for an endpoint. Possible endpoint categories include: systemic, developmental, reproductive, and cholinesterase.", - "maxLength": 255, - "minLength": 0 - }, - "endpointType": { - "type": "string", - "description": "The subcategory for endpoint_category, which is more descriptive for a particular endpoint (e.g. pathology gross, clinical chemistry, reproductive performance, etc.)", - "maxLength": 255, - "minLength": 0 - }, - "endpointTarget": { - "type": "string", - "description": "More specific description than endpoint_type, often indicating where or how the sample was collected to supply data for a particular endpoint. Target may describe an organ, tissue, metabolite or protein measured.", - "maxLength": 255, - "minLength": 0 - }, - "effectDesc": { - "type": "string", - "description": "More specific description for an effect than endpoint_category, usually detailing a specific condition associated with an endpoint_target (e.g. dysplasia, atrophy, necrosis, etc.).", - "maxLength": 255, - "minLength": 0 - }, - "effectDescFree": { - "type": "string", - "description": "Brief verbatim text from study file that was entered if the effect description differed from predetermined endpoint terminology.", - "maxLength": 255, - "minLength": 0 - }, - "cancerRelated": { - "type": "boolean", - "description": "Indicates if effect is considered cancer related (1) or not." - }, - "targetSite": { - "type": "string", - "description": "A more specific description than effect_target. Can describe a specific tissue within an organ, type of cell, etc.", - "maxLength": 64, - "minLength": 0 - }, - "direction": { - "type": "integer", - "format": "int32", - "description": "Description of the net change across all doses that indicates whether the numerical data increased, decreased, or stayed the same. Also can be used to describe effects that did not have numerical data, but were still described in the study source." - }, - "effectComment": { - "type": "string", - "description": "NULL if no additional comment needed; contains information that the extractor/curator found helpful in describing issues related to a treatment-group-effect (e.g. units not reported, effect only reported for certain treatment groups, etc.).", - "maxLength": 1024, - "minLength": 0 - }, - "treatmentRelated": { - "type": "boolean", - "description": "Boolean description for an effect by dose treatment group. “TRUE” indicates there was a statistically significant difference from the control group for the effect; “FALSE” indicates there was no difference from control group. The highest dose level at which no significant observable adverse effects were observed corresponds to the no effect level (NEL). The lowest effect level (LEL) can be inferred by treatment related effects." - }, - "criticalEffect": { - "type": "boolean", - "description": "Boolean description for an effect by dose treatment group. “TRUE” corresponds to a toxic or adverse effect denoted in the study summary or via expert judgement using a weight-of-evidence approach. “FALSE” indicates that although an effect is produced at this level, it is not considered adverse, nor immediate precursors to specific adverse effects. If there are several critical effects, the no observed adverse effect level (NOAEL) is determined from the highest dose level without critical effects. The lowest dose level at which the critical effect was observed in a study is the lowest observed adverse effect level (LOAEL.)" - }, - "sampleSize": { - "type": "string", - "description": "Number of animals used for an examination for a particular effect.", - "maxLength": 8, - "minLength": 0 - }, - "effectVal": { - "type": "number", - "format": "double", - "description": "Numeric value of a measured effect, can be continuous or dichotomous (incidence) data." - }, - "effectValUnit": { - "type": "string", - "description": "Unit associated with the effect value.", - "maxLength": 128, - "minLength": 0 - }, - "effectVar": { - "type": "number", - "format": "double", - "description": "Measurement of the variance for a set of data associated with a measured effect, generally reported as the standard deviation (SD) or standard error (SE)." - }, - "effectVarType": { - "type": "string", - "description": "Name of the variance metric used to determine the effect variance, typically the standard deviation (SD) or standard error (SE). Other effect_var types include: interquartile range, 95% confidence limit, and none.", - "maxLength": 32, - "minLength": 0 - }, - "time": { - "type": "number", - "format": "double", - "description": "Numeric value associated with the duration of the exposure at which a particular effect was measured or observed, typically reported in hours, days, weeks, or months." - }, - "timeUnit": { - "type": "string", - "description": " Unit associated with the duration of the exposure at which a particular effect was measured or observed, typically reported in hours, days, weeks, or months.", - "maxLength": 64, - "minLength": 0 - }, - "noQuantDataReported": { - "type": "boolean", - "description": "Indicates if qualitative (1) or quantitative (0) effect data was reported." - }, - "exportDate": { - "type": "string", - "format": "date", - "description": "Date view of ToxRefDB data was created for API" - }, - "version": { - "type": "string", - "description": "Version of ToxRefDB data" - } - }, - "required": [ - "id" - ] - }, - "ToxRefData": { - "type": "object", - "description": "Export of all extracted dose-treatment group-effect information as well as doses not eliciting effects from ToxRefDB for the chemicals, studies, or study types listed in the input. Data from ToxRefDB is also summarized in ToxValDB, including inferred NEL and NOAEL effect levels based on the reported LEL and LOAEL, respectively.", - "properties": { - "id": { - "type": "integer", - "format": "int32" - }, - "studyId": { - "type": "integer", - "format": "int32", - "description": "A unique numeric identifier for each study in the database." - }, - "dtxsid": { - "type": "string", - "description": "Unique identifier from DSSTox", - "maxLength": 45, - "minLength": 0 - }, - "casrn": { - "type": "string", - "description": "Curated casrn from DSSTOX chemical curation", - "maxLength": 255, - "minLength": 0 - }, - "name": { - "type": "string", - "description": "Curated chemical name from DSSTOX chemical curation", - "maxLength": 255, - "minLength": 0 - }, - "studySource": { - "type": "string", - "description": "Organization that provided or authored the document for curation.", - "maxLength": 255, - "minLength": 0 - }, - "studySourceId": { - "type": "string", - "description": "Unique document identifier provided by the study source.", - "maxLength": 255, - "minLength": 0 - }, - "citation": { - "type": "string", - "description": "Citation in source document", - "maxLength": 1024, - "minLength": 0 - }, - "studyYear": { - "type": "integer", - "format": "int32" - }, - "studyType": { - "type": "string", - "description": "Classification to describe animal toxicity testing that was conducted. Based on either dose period, subjects involved, or measured effects of interest, study types include: ACU (acute): Dose period typically a day or less. Excludes developmental and neurological studies.; SAC (subacute): Dose period is typically 21-28 days. Excludes developmental and neurological studies.; SUB (subchronic): Dose period is typically 13 weeks, but may be as long as 6 months. Excludes developmental and neurological studies.; CHR (chronic): Dose period is typically 12, 18, or 24 months (generally any dosing lasting a year or longer). Excludes developmental and neurological studies.; DEV (developmental): Gestational (in utero) dose period. Sacrificed prior to delivery.; MGR (multigenerational reproductive): Dose period begins in adolescent F0 males and females and continues until terminal generation. At least some of the litters deliver their pups, some may be sacrificed prior to delivery.; NEU (neurological): Study contains functional observation battery or other battery of behavioral testing that occurs during or after dosing. Pathology has specific interest in the brain (i.e. regions, morphology, biochemistry, et cetera). excludes developmental studies; DNT (developmental neurotoxicity): dose period occurs anytime during development (i.e. in utero, lactational, adolescent [after weaning, before adulthood]). Study contains functional observation battery or other battery of behavioral testing that occurs during or after dosing, typically during adulthood. Pathology has specific interest in the brain (i.e. regions, morphology, biochemistry, etc.)", - "maxLength": 255, - "minLength": 0 - }, - "studyTypeGuideline": { - "type": "string", - "description": "Description that combines the study_type and guideline name for a study.", - "maxLength": 255, - "minLength": 0 - }, - "species": { - "type": "string", - "description": "Species of the animal test subject used in a study.", - "maxLength": 255, - "minLength": 0 - }, - "strainGroup": { - "type": "string", - "description": "Descriptive category for a group of test animals that is more general than the strain. ", - "maxLength": 255, - "minLength": 0 - }, - "strain": { - "type": "string", - "description": "Intraspecific description of group of animals used in a study; generally, a stock of animals that share a uniform morphological or physiological character, or group that is genetically uniform.", - "maxLength": 255, - "minLength": 0 - }, - "adminRoute": { - "type": "string", - "description": "Path by which test substance was administered to animal. Options include oral, dermal, inhalation, injection, or other.", - "maxLength": 255, - "minLength": 0 - }, - "adminMethod": { - "type": "string", - "description": "Specific path by which the test substance was administered via the administration route. Examples include capsule, diet, gavage, or topical.", - "maxLength": 255, - "minLength": 0 - }, - "doseDuration": { - "type": "integer", - "format": "int32", - "description": "Amount of time a group is dosed. This varies within studies depending on the dose period of a particular treatment group." - }, - "doseDurationUnit": { - "type": "string", - "description": "Unit of time associated with the dose duration. Typically in days or months.", - "maxLength": 16, - "minLength": 0 - }, - "doseStart": { - "type": "integer", - "format": "int32", - "description": "Time during an animal's life that the administration of a test substance began." - }, - "doseStartUnit": { - "type": "string", - "description": "Unit of time associated with the start of the dose (dose_start).", - "maxLength": 255, - "minLength": 0 - }, - "doseEnd": { - "type": "integer", - "format": "int32", - "description": "Time during an animal's life that the administration of a test substance stopped." - }, - "doseEndUnit": { - "type": "string", - "description": "Unit of time associated with the end of the dose (dose_end).", - "maxLength": 255, - "minLength": 0 - }, - "dosePeriod": { - "type": "string", - "description": "Period within a group's lifetime that the animals were dosed and the sample for an endpoint's data was taken (when the animals were sacrificed).", - "maxLength": 32, - "minLength": 0 - }, - "doseLevel": { - "type": "integer", - "format": "int32", - "description": "Numeric rank indicating the level of dose administered to test animals, with lower dose levels indicating lower concentrations of a chemical (e.g., 0 = vehicle, 1 = lowest dose, etc.). The dose level for some studies may be staggered since concentrations may vary by sex (e.g, male treatment group: 0 = vehicle, 1 = lowest dose, 3 = second lowest dose, etc.)." - }, - "conc": { - "type": "number", - "format": "double", - "description": "Concentration of a test chemical, typically reported in ppm within the exposure matrix (e.g., feed or water)." - }, - "concUnit": { - "type": "string", - "description": "Unit associated with a concentration of a test chemical, typically reported as ppm.", - "maxLength": 255, - "minLength": 0 - }, - "vehicle": { - "type": "string", - "description": "The media used in administration of the chemical.", - "maxLength": 255, - "minLength": 0 - }, - "doseComment": { - "type": "string", - "description": "NULL if no additional comment needed. Field can be used to explain any differences in dosing over the dosing interval and/or clarifying comments on how the dose was administered.", - "maxLength": 1024, - "minLength": 0 - }, - "doseAdjusted": { - "type": "number", - "description": "The amount of the chemical administered in mg/kg of body weight/day (mg/kg/day). This value is typically different between male and female groups receiving the same dose concentration (conc) due to differences in bodyweight. If dose_adjusted values were not provided in a study, then they were calculated using species scaling factors (FAO/WHO, 2000)." - }, - "doseAdjustedUnit": { - "type": "string", - "description": "Unit associated with the adjusted dose of a chemical, typically reported in mg/kg/day.", - "maxLength": 32, - "minLength": 0 - }, - "sex": { - "type": "string", - "description": "Gender of a test animal. The gender of fetal groups is denoted as MF for both males and females.", - "maxLength": 8, - "minLength": 0 - }, - "generation": { - "type": "string", - "description": "Generation a test animal belongs to. The F0 generation is the first generation mating group for MGR studies and is the default for non-reproductive studies (CHR, SUB, SAC). F1 is the second generation mating group, selected from either F1a or F1b litters. F2 is the third generation mating group, selected from either F2a or F2b litters. F1a and F1b are the first and second litter groups produced by F0 matings, F2a and F2b are the first and second litter groups produced by F1 matings, and F3a and F3b are the first and second litter groups produced by F2 matings. The fetal generation is the group produced by F0 matings in DEV studies, and are typically removed from a female via cesarean section in DEV studies.", - "maxLength": 16, - "minLength": 0 - }, - "lifeStage": { - "type": "string", - "description": "Stage of life that a measurement was taken. CHR, SUB, and SAC studies typically only have adult for life_stage, whereas DEV and MGR studies will always be characterized by multiple life stages. The different life stages in the database include: fetal, juvenile, adult, adult-pregnancy and pregnancy.", - "maxLength": 32, - "minLength": 0 - }, - "numAnimals": { - "type": "number", - "description": "Number of animals per treatment group" - }, - "tgComment": { - "type": "string", - "description": "NULL if no additional comment needed; contains information that the extractor/curator found helpful in describing issues related to a treatment-group (e.g. animals dosed via capsule so concentration not reported, added recovery groups, etc.). ", - "maxLength": 1024, - "minLength": 0 - }, - "endpointCategory": { - "type": "string", - "description": "The broadest descriptive term for an endpoint. Possible endpoint categories include: systemic, developmental, reproductive, and cholinesterase.", - "maxLength": 255, - "minLength": 0 - }, - "endpointType": { - "type": "string", - "description": "The subcategory for endpoint_category, which is more descriptive for a particular endpoint (e.g. pathology gross, clinical chemistry, reproductive performance, etc.)", - "maxLength": 255, - "minLength": 0 - }, - "endpointTarget": { - "type": "string", - "description": "More specific description than endpoint_type, often indicating where or how the sample was collected to supply data for a particular endpoint. Target may describe an organ, tissue, metabolite or protein measured.", - "maxLength": 255, - "minLength": 0 - }, - "effectDesc": { - "type": "string", - "description": "More specific description for an effect than endpoint_category, usually detailing a specific condition associated with an endpoint_target (e.g. dysplasia, atrophy, necrosis, etc.).", - "maxLength": 255, - "minLength": 0 - }, - "effectDescFree": { - "type": "string", - "description": "Brief verbatim text from study file that was entered if the effect description differed from predetermined endpoint terminology.", - "maxLength": 255, - "minLength": 0 - }, - "cancerRelated": { - "type": "boolean", - "description": "Indicates if effect is considered cancer related (1) or not." - }, - "targetSite": { - "type": "string", - "description": "A more specific description than effect_target. Can describe a specific tissue within an organ, type of cell, etc.", - "maxLength": 64, - "minLength": 0 - }, - "direction": { - "type": "integer", - "format": "int32", - "description": "Description of the net change across all doses that indicates whether the numerical data increased, decreased, or stayed the same. Also can be used to describe effects that did not have numerical data, but were still described in the study source." - }, - "effectComment": { - "type": "string", - "description": "NULL if no additional comment needed; contains information that the extractor/curator found helpful in describing issues related to a treatment-group-effect (e.g. units not reported, effect only reported for certain treatment groups, etc.).", - "maxLength": 1024, - "minLength": 0 - }, - "treatmentRelated": { - "type": "boolean", - "description": "Boolean description for an effect by dose treatment group. “TRUE” indicates there was a statistically significant difference from the control group for the effect; “FALSE” indicates there was no difference from control group. The highest dose level at which no significant observable adverse effects were observed corresponds to the no effect level (NEL). The lowest effect level (LEL) can be inferred by treatment related effects." - }, - "criticalEffect": { - "type": "boolean", - "description": "Boolean description for an effect by dose treatment group. “TRUE” corresponds to a toxic or adverse effect denoted in the study summary or via expert judgement using a weight-of-evidence approach. “FALSE” indicates that although an effect is produced at this level, it is not considered adverse, nor immediate precursors to specific adverse effects. If there are several critical effects, the no observed adverse effect level (NOAEL) is determined from the highest dose level without critical effects. The lowest dose level at which the critical effect was observed in a study is the lowest observed adverse effect level (LOAEL.)" - }, - "sampleSize": { - "type": "string", - "description": "Number of animals used for an examination for a particular effect.", - "maxLength": 8, - "minLength": 0 - }, - "effectVal": { - "type": "number", - "format": "double", - "description": "Numeric value of a measured effect, can be continuous or dichotomous (incidence) data." - }, - "effectValUnit": { - "type": "string", - "description": "Unit associated with the effect value.", - "maxLength": 128, - "minLength": 0 - }, - "effectVar": { - "type": "number", - "format": "double", - "description": "Measurement of the variance for a set of data associated with a measured effect, generally reported as the standard deviation (SD) or standard error (SE)." - }, - "effectVarType": { - "type": "string", - "description": "Name of the variance metric used to determine the effect variance, typically the standard deviation (SD) or standard error (SE). Other effect_var types include: interquartile range, 95% confidence limit, and none.", - "maxLength": 32, - "minLength": 0 - }, - "time": { - "type": "number", - "format": "double", - "description": "Numeric value associated with the duration of the exposure at which a particular effect was measured or observed, typically reported in hours, days, weeks, or months." - }, - "timeUnit": { - "type": "string", - "description": " Unit associated with the duration of the exposure at which a particular effect was measured or observed, typically reported in hours, days, weeks, or months.", - "maxLength": 64, - "minLength": 0 - }, - "noQuantDataReported": { - "type": "boolean", - "description": "Indicates if qualitative (1) or quantitative (0) effect data was reported." - }, - "exportDate": { - "type": "string", - "format": "date", - "description": "Date view of ToxRefDB data was created for API" - }, - "version": { - "type": "string", - "description": "Version of ToxRefDB data" - } - }, - "required": [ - "id" - ] - }, - "Pprtv": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int32" - }, - "dtxsid": { - "type": "string", - "description": "Distributed Structure-Searchable Toxicity (DSSTox) id", - "maxLength": 45, - "minLength": 0 - }, - "pprtvSubstanceId": { - "type": "integer", - "format": "int32" - }, - "name": { - "type": "string" - }, - "casrn": { - "type": "string" - }, - "lastRevision": { - "type": "integer", - "format": "int32" - }, - "pprtvAssessment": { - "type": "string" - }, - "irisLink": { - "type": "string" - }, - "rfcValue": { - "type": "string" - }, - "rfdValue": { - "type": "string" - }, - "woe": { - "type": "string" - } - }, - "required": [ - "id" - ] - }, - "Iris": { - "type": "object", - "description": "Integrated Risk Information System (IRIS): EPA's IRIS Program identifies and characterizes the health hazards of chemicals found in the environment. Each IRIS assessment can cover a chemical, a group of related chemicals, or a complex mixture. IRIS assessments are an important source of toxicity information used by EPA, state and local health agencies, other federal agencies, and international health organizations.", - "properties": { - "dtxsid": { - "type": "string" - }, - "chemicalName": { - "type": "string" - }, - "casrn": { - "type": "string" - }, - "lastSignificantRevision": { - "type": "string", - "format": "date" - }, - "literatureScreeningReview": { - "type": "string" - }, - "criticalEffectsSystems": { - "type": "string" - }, - "rfdChronic": { - "type": "string" - }, - "rfdSubchronic": { - "type": "string" - }, - "rfcChronic": { - "type": "string" - }, - "rfcSubchronic": { - "type": "string" - }, - "tumorSite": { - "type": "string" - }, - "irisUrl": { - "type": "string" - } - }, - "required": [ - "dtxsid" - ] - }, - "Hawc": { - "type": "object", - "description": "EPA Health Assessment Workspace Collaborative (HAWC). EPA HAWC is an interactive, expert-driven, content management system for EPA health and environmental risk assessment programs that is intended to promote transparency, data usability, and understanding of the data and decisions supporting health and environmental assessments. Specifically, EPA HAWC is an application that allows the data and decisions supporting an assessment to be evaluated and managed in modules (e.g., study evaluation, summary study data) that can then be publicly accessed online.", - "properties": { - "id": { - "type": "integer", - "format": "int32" - }, - "name": { - "type": "string" - }, - "year": { - "type": "integer", - "format": "int32" - }, - "dtxsid": { - "type": "string" - }, - "ccdUrl": { - "type": "string" - }, - "hawcUrl": { - "type": "string" - } - }, - "required": [ - "id" - ] - }, - "CcdGenetoxDetail": { - "type": "object", - "properties": { - "year": { - "type": "integer", - "format": "int32" - }, - "source": { - "type": "string" - }, - "assayType": { - "type": "string" - }, - "assayCategory": { - "type": "string" - }, - "assayResult": { - "type": "string" - }, - "species": { - "type": "string" - }, - "dtxsid": { - "type": "string" - }, - "strain": { - "type": "string" - }, - "metabolicActivation": { - "type": "string" - } - } - }, - "Adme": { - "type": "object", - "description": "The information here describes toxicokinetics in humans. Values are 1) measured either in vitro or in vivo, 2) predicted from chemical properties using in silico tools, or 3) computed with mathematical models simulating toxicokinetics. Note: intrinsic hepatic clearance and fraction unbound in plasma values can have measured values listed, but these may be assumed from measured data using a surrogate species. The Data Source Species column identifies the measured data species source. We use these assumed measured values in calculations to estimate other outcomes, such as volume of distribution, PK half life, and steady-state plasma concentration. The in vitro measured values reflect the value curated for the open source R package “httk”. The computed values are generated with httk using the reported in vitro values. \"https://CRAN.R-project.org/package=httk\". The in vivo measured values are estimated from toxicokinetic concentration vs. time contained in the CvTdb (https://doi.org/10.1038/s41597-020-0455-1). In vivo estimates are calculated using R package “invivoPKfit” (https://github.com/USEPA/CompTox-ExpoCast-invivoPKfit)", - "properties": { - "id": { - "type": "integer", - "format": "int32" - }, - "dtxsid": { - "type": "string", - "description": "Distributed Structure-Searchable Toxicity (DSSTox) id" - }, - "description": { - "type": "string" - }, - "measured": { - "type": "string" - }, - "predicted": { - "type": "string" - }, - "unit": { - "type": "string", - "maxLength": 30, - "minLength": 0 - }, - "model": { - "type": "string" - }, - "reference": { - "type": "string" - }, - "percentile": { - "type": "string" - }, - "species": { - "type": "string" - }, - "dataSourceSpecies": { - "type": "string" - } - }, - "required": [ - "id" - ] - }, - "CcdADME": { - "type": "object", - "properties": { - "reference": { - "type": "string" - }, - "description": { - "type": "string" - }, - "label": { - "type": "string" - }, - "dataSourceSpecies": { - "type": "string" - }, - "species": { - "type": "string" - }, - "unit": { - "type": "string" - }, - "model": { - "type": "string" - }, - "dtxsid": { - "type": "string" - }, - "measured": { - "type": "string" - }, - "predicted": { - "type": "string" - }, - "percentile": { - "type": "string" - } - } + ] + } + } } + } }, - "securitySchemes": { - "api_key": { - "type": "apiKey", - "description": "Each API request requires an api_key. Contact the CTX API Admin to request an API Key.", - "name": "x-api-key", - "in": "header" + "security": [ + { + "api_key": [] + } + ] + } + } + }, + "components": { + "schemas": { + "ToxValDb": { + "type": "object", + "description": "The Toxicity Values Database (ToxValDB) is a compilation of toxicity information from world-wide sites, databases, and sources, which can save the user time by providing information in one location. The data are largely limited to summary values from individual studies or chemical-level assessments, and is focused on quantitative values such as LOAELs, NOAELs, BMDs, LD50s and RfDs. The user must apply judgment in use of the information and should consult the original scientific paper or data source, if possible, to ensure an understanding of the context of the data. The ToxValDB SQL download is available at https://www.epa.gov/comptox-tools/downloadable-computational-toxicology-data#AT .", + "properties": { + "id": { + "type": "integer", + "format": "int32" + }, + "dtxsid": { + "type": "string", + "description": "Distributed Structure-Searchable Toxicity (DSSTox) id", + "maxLength": 45, + "minLength": 0 + }, + "casrn": { + "type": "string" + }, + "name": { + "type": "string" + }, + "source": { + "type": "string", + "description": "Originator of source data", + "maxLength": 255, + "minLength": 0 + }, + "subsource": { + "type": "string", + "description": "Additional source reference", + "maxLength": 255, + "minLength": 0 + }, + "toxvalType": { + "type": "string", + "description": "Categorization of records based on POD or effect level. Categories include: Point of Departure (The quantitative result of an in vivo repeat dose study, such as a LOAEL, NOAEL or BMDL), Lethality Effect Level (The quantitative result of an in vivo acute study, such as a LD50 or LC50), Toxicity Value (A risk assessment summary value for a chemical, such as an RFD or cancer slope factor), Screening Level (An environmentally safe concentration, primarily EPA Regional Screening levels), Exposure Limit (Exposure levels of concern in air, water, or other media), Effect Time (A time when an effect is seen for a fixed concentration. These values all come from the ECOTOX Knowledgebase), Effect Level (A value similar to a Point of Departure, but not linked to a critical effect), Effect Dose (Similar to a Lethality Effect Level but for non-lethal ecotoxicology endpoints in acute studies), Inhibition Concentration (Similar to a Lethality Effect Level but for non-lethal ecotoxicology endpoints, focused on inhibition of growth), Other (Other uncharacterized classes of records)", + "maxLength": 255, + "minLength": 0 + }, + "toxvalTypeDefinition": { + "type": "string" + }, + "toxvalSubtype": { + "type": "string", + "description": "Effect subtype or value subtype", + "maxLength": 255, + "minLength": 0 + }, + "toxvalTypeSuperCategory": { + "type": "string", + "maxLength": 255, + "minLength": 0 + }, + "qualifier": { + "type": "string", + "description": "Operators (\u003C, \u003C=, \u003E, \u003E=, =) to contextualize level of certainty in estimates", + "maxLength": 255, + "minLength": 0 + }, + "toxvalNumeric": { + "type": "number", + "format": "double", + "description": "Concentration of a test chemical, typically reported in ppm within the exposure matrix (e.g., feed or water), or the an adjusted amount of the chemical administered in mg/kg of body weight/day (mg/kg/day)" + }, + "toxvalUnits": { + "type": "string", + "description": "Unit associated with the concentration or adjusted dose of a chemical", + "maxLength": 255, + "minLength": 0 + }, + "riskAssessmentClass": { + "type": "string", + "description": "Designation of cancer or non-cancer for toxicity values or media associated with exposure guideline values", + "maxLength": 255, + "minLength": 0 + }, + "humanEco": { + "type": "string", + "maxLength": 255, + "minLength": 0 + }, + "studyType": { + "type": "string", + "description": "Classification to describe toxicity testing that was conducted", + "maxLength": 255, + "minLength": 0 + }, + "studyDurationClass": { + "type": "string", + "description": "Categorical description of exposure duration ", + "maxLength": 255, + "minLength": 0 + }, + "studyDurationValue": { + "type": "number", + "format": "double", + "description": "Amount of time a group is dosed. This varies within studies depending on the dose period of a particular treatment group" + }, + "studyDurationUnits": { + "type": "string", + "description": "Unit of time associated with the dose duration. Typically in days or months", + "maxLength": 255, + "minLength": 0 + }, + "speciesCommon": { + "type": "string", + "description": "Species of the animal test subject used in a study", + "maxLength": 255, + "minLength": 0 + }, + "strain": { + "type": "string", + "description": "Intraspecific description of group of animals used in a study; generally, a stock of animals that share a uniform morphological or physiological character, or group that is genetically uniform", + "maxLength": 255, + "minLength": 0 + }, + "latinName": { + "type": "string", + "maxLength": 255, + "minLength": 0 + }, + "speciesSupercategory": { + "type": "string", + "description": "Categorization of effect or value type into one of five categories, including dose response summary value, mortality response summary value, toxicity value, media exposure guidelines, or acute exposure guidelines", + "maxLength": 255, + "minLength": 0 + }, + "sex": { + "type": "string", + "description": "Gender of a test animal. The gender of fetal groups is denoted as MF for both males and females", + "maxLength": 255, + "minLength": 0 + }, + "generation": { + "type": "string", + "description": "Generation a test animal belongs to", + "maxLength": 255, + "minLength": 0 + }, + "lifestage": { + "type": "string", + "description": "Stage of life that a measurement was taken", + "maxLength": 255, + "minLength": 0 + }, + "exposureRoute": { + "type": "string", + "description": "Path by which test substance was administered to animal. Options include oral, dermal, inhalation, injection, or other", + "maxLength": 255, + "minLength": 0 + }, + "exposureMethod": { + "type": "string", + "description": "Specific path by which the test substance was administered via the administration route. Examples include capsule, diet, gavage, or topical", + "maxLength": 255, + "minLength": 0 + }, + "exposureForm": { + "type": "string", + "description": "The vehicle used in administration of the chemical", + "maxLength": 255, + "minLength": 0 + }, + "media": { + "type": "string", + "maxLength": 255, + "minLength": 0 + }, + "toxicologicalEffect": { + "type": "string", + "description": "Treatment-associated effect " + }, + "experimentalRecord": { + "type": "string" + }, + "studyGroup": { + "type": "string", + "maxLength": 255, + "minLength": 0 + }, + "longRef": { + "type": "string" + }, + "doi": { + "type": "string" + }, + "title": { + "type": "string" + }, + "author": { + "type": "string", + "maxLength": 255, + "minLength": 0 + }, + "year": { + "type": "string", + "maxLength": 255, + "minLength": 0 + }, + "guideline": { + "type": "string", + "maxLength": 255, + "minLength": 0 + }, + "quality": { + "type": "string", + "maxLength": 255, + "minLength": 0 + }, + "qcCategory": { + "type": "string" + }, + "sourceHash": { + "type": "string", + "maxLength": 45, + "minLength": 0 + }, + "externalSourceId": { + "type": "string" + }, + "externalSourceIdDesc": { + "type": "string" + }, + "sourceUrl": { + "type": "string", + "description": "URL for source data", + "maxLength": 255, + "minLength": 0 + }, + "subsourceUrl": { + "type": "string", + "description": "Additional URL reference for source data", + "maxLength": 255, + "minLength": 0 + }, + "storedSourceRecord": { + "type": "string", + "maxLength": 255, + "minLength": 0 + }, + "toxvalTypeOriginal": { + "type": "string", + "description": "Categorization of records based on POD or effect level. Categories include: Point of Departure (The quantitative result of an in vivo repeat dose study, such as a LOAEL, NOAEL or BMDL), Lethality Effect Level (The quantitative result of an in vivo acute study, such as a LD50 or LC50), Toxicity Value (A risk assessment summary value for a chemical, such as an RFD or cancer slope factor), Screening Level (An environmentally safe concentration, primarily EPA Regional Screening levels), Exposure Limit (Exposure levels of concern in air, water, or other media), Effect Time (A time when an effect is seen for a fixed concentration. These values all come from the ECOTOX Knowledgebase), Effect Level (A value similar to a Point of Departure, but not linked to a critical effect), Effect Dose (Similar to a Lethality Effect Level but for non-lethal ecotoxicology endpoints in acute studies), Inhibition Concentration (Similar to a Lethality Effect Level but for non-lethal ecotoxicology endpoints, focused on inhibition of growth), Other (Other uncharacterized classes of records) (original)", + "maxLength": 255, + "minLength": 0 + }, + "toxvalSubtypeOriginal": { + "type": "string", + "description": "Effect subtype or value subtype (original)", + "maxLength": 255, + "minLength": 0 + }, + "toxvalNumericOriginal": { + "type": "number", + "format": "double", + "description": "Concentration of a test chemical, typically reported in ppm within the exposure matrix (e.g., feed or water), or the an adjusted amount of the chemical administered in mg/kg of body weight/day (mg/kg/day) (original)", + "maximum": 255, + "minimum": 0 + }, + "toxvalUnitsOriginal": { + "type": "string", + "description": "Unit associated with the concentration or adjusted dose of a chemical (original)", + "maxLength": 255, + "minLength": 0 + }, + "studyTypeOriginal": { + "type": "string", + "description": "Classification to describe toxicity testing that was conducted (original)", + "maxLength": 255, + "minLength": 0 + }, + "studyDurationClassOriginal": { + "type": "string", + "description": "Categorical description of exposure duration (original)", + "maxLength": 255, + "minLength": 0 + }, + "studyDurationValueOriginal": { + "type": "string", + "description": "Amount of time a group is dosed. This varies within studies depending on the dose period of a particular treatment group (original)", + "maxLength": 255, + "minLength": 0 + }, + "studyDurationUnitsOriginal": { + "type": "string", + "description": "Unit of time associated with the dose duration. Typically in days or months (original)", + "maxLength": 255, + "minLength": 0 + }, + "speciesOriginal": { + "type": "string", + "description": "Species of the animal test subject used in a study (original)", + "maxLength": 255, + "minLength": 0 + }, + "strainOriginal": { + "type": "string", + "description": "Intraspecific description of group of animals used in a study; generally, a stock of animals that share a uniform morphological or physiological character, or group that is genetically uniform (original)", + "maxLength": 255, + "minLength": 0 + }, + "sexOriginal": { + "type": "string", + "description": "Gender of a test animal. The gender of fetal groups is denoted as MF for both males and females (original)", + "maxLength": 255, + "minLength": 0 + }, + "generationOriginal": { + "type": "string", + "description": "Generation a test animal belongs to (original)", + "maxLength": 255, + "minLength": 0 + }, + "lifestageOriginal": { + "type": "string", + "description": "Stage of life that a measurement was taken (original)", + "maxLength": 255, + "minLength": 0 + }, + "exposureRouteOriginal": { + "type": "string", + "description": "Path by which test substance was administered to animal. Options include oral, dermal, inhalation, injection, or other (original)", + "maxLength": 255, + "minLength": 0 + }, + "exposureMethodOriginal": { + "type": "string", + "description": "Specific path by which the test substance was administered via the administration route. Examples include capsule, diet, gavage, or topical (original", + "maxLength": 255, + "minLength": 0 + }, + "exposureFormOriginal": { + "type": "string", + "description": "The vehicle used in administration of the chemical (original)", + "maxLength": 255, + "minLength": 0 + }, + "mediaOriginal": { + "type": "string", + "maxLength": 255, + "minLength": 0 + }, + "toxicologicalEffectOriginal": { + "type": "string", + "description": "Treatment-associated effect (original)" + }, + "originalYear": { + "type": "string", + "description": "Year in which the study was reported as finished", + "maxLength": 255, + "minLength": 0 + } + }, + "required": [ + "id" + ] + }, + "ProblemDetail": { + "type": "object", + "properties": { + "type": { + "type": "string", + "format": "uri" + }, + "title": { + "type": "string" + }, + "status": { + "type": "integer", + "format": "int32" + }, + "detail": { + "type": "string" + }, + "instance": { + "type": "string", + "format": "uri" + }, + "properties": { + "type": "object", + "additionalProperties": { + } + } } + }, + "SkinEye": { + "type": "object", + "description": "Skin and eye irritation tests are used to assess the safety of products and chemicals that may come into contact with the skin or eyes. These tests are important for labeling and registering chemicals and agrochemicals, and for developing drugs. Types of skin and eye irritation tests include Draize test, EpiOcular Eye Irritation Test (EIT), Red blood cells test, or Patch test", + "properties": { + "id": { + "type": "integer", + "format": "int32" + }, + "authority": { + "type": "string", + "maxLength": 45, + "minLength": 0 + }, + "classification": { + "type": "string", + "description": "Classification into hazard categories based on the severity of the skin or eye irritation", + "maxLength": 255, + "minLength": 0 + }, + "dtxsid": { + "type": "string", + "description": "Distributed Structure-Searchable Toxicity (DSSTox) id ", + "maxLength": 255, + "minLength": 0 + }, + "endpoint": { + "type": "string", + "description": "Skin sensitization or eye irritation", + "maxLength": 255, + "minLength": 0 + }, + "glp": { + "type": "string" + }, + "guideline": { + "type": "string", + "description": "Number associated with the particular guideline that a test adheres to or most closely adheres to" + }, + "recordUrl": { + "type": "string", + "maxLength": 1024, + "minLength": 0 + }, + "reliability": { + "type": "string", + "description": "Ranking of reliability of results", + "maxLength": 45, + "minLength": 0 + }, + "resultText": { + "type": "string", + "description": "Annotation describing results", + "maxLength": 1024, + "minLength": 0 + }, + "score": { + "type": "string", + "description": "Hazard scoring based on classification", + "maxLength": 45, + "minLength": 0 + }, + "skinEyeHash": { + "type": "string", + "maxLength": 255, + "minLength": 0 + }, + "skinEyeId": { + "type": "integer", + "format": "int32" + }, + "skinEyeUuid": { + "type": "string", + "maxLength": 255, + "minLength": 0 + }, + "source": { + "type": "string", + "description": "Originator of source data", + "maxLength": 45, + "minLength": 0 + }, + "species": { + "type": "string", + "description": "Species of the animal test subject used in a study", + "maxLength": 255, + "minLength": 0 + }, + "strain": { + "type": "string", + "description": "Intraspecific description of group of animals used in a study; generally, a stock of animals that share a uniform morphological or physiological character, or group that is genetically uniform", + "maxLength": 255, + "minLength": 0 + }, + "studyType": { + "type": "string", + "description": "Classification to describe testing that was conducted", + "maxLength": 255, + "minLength": 0 + }, + "year": { + "type": "integer", + "format": "int32", + "description": "Year in which the study was reported as finished" + } + }, + "required": [ + "id" + ] + }, + "GenetoxSummary": { + "type": "object", + "description": "Description: Genotoxicity testing, also known as short-term assays, is used to evaluate the potential adverse effects of chemicals on human health. These tests can help identify carcinogens, as about 80% of known human carcinogens are genotoxic. The results of genotoxicity tests are important because of the irreversible nature and severity of the health effects that may result from genotoxic events. There are many different techniques that can be used for genotoxicity testing, notably including Ames test (comparative genetic analysis using multiple bacterial strains of Salmonella typhimurium), Comet assay (measurement DNA strand breaks), micronucleus test (cytogenetic assay that uses fluorescence in situ hybridization and chromosome painting) and chromosomal aberration test (cytogenetic assay that examines in vivo tissues to reflect how chemicals are absorbed, excreted, distributed, and metabolized). This endpoint provides summary-level genotoxicity data associated to a chemical.", + "properties": { + "id": { + "type": "integer", + "format": "int32" + }, + "ames": { + "type": "string", + "description": "Average result in AMES test", + "maxLength": 255, + "minLength": 0 + }, + "clowderDocId": { + "type": "string", + "maxLength": 65, + "minLength": 0 + }, + "dtxsid": { + "type": "string", + "description": "Distributed Structure-Searchable Toxicity (DSSTox) id", + "maxLength": 255, + "minLength": 0 + }, + "genetoxCall": { + "type": "string", + "maxLength": 255, + "minLength": 0 + }, + "genetoxSummaryId": { + "type": "integer", + "format": "int32" + }, + "micronucleus": { + "type": "string", + "description": "Average result in Micronucleus test", + "maxLength": 255, + "minLength": 0 + }, + "reportsNegative": { + "type": "integer", + "format": "int32", + "description": "Count of genetox records reporting negative results" + }, + "reportsOther": { + "type": "integer", + "format": "int32", + "description": "Count of genetox records reporting ‘other’ in results" + }, + "reportsPositive": { + "type": "integer", + "format": "int32", + "description": "Count of genetox records reporting positive results" + } + }, + "required": [ + "id" + ] + }, + "GenetoxDetail": { + "type": "object", + "description": "Description: Genotoxicity testing, also known as short-term assays, is used to evaluate the potential adverse effects of chemicals on human health. These tests can help identify carcinogens, as about 80% of known human carcinogens are genotoxic. The results of genotoxicity tests are important because of the irreversible nature and severity of the health effects that may result from genotoxic events. There are many different techniques that can be used for genotoxicity testing, notably including Ames test (comparative genetic analysis using multiple bacterial strains of Salmonella typhimurium), Comet assay (measurement DNA strand breaks), micronucleus test (cytogenetic assay that uses fluorescence in situ hybridization and chromosome painting) and chromosomal aberration test (cytogenetic assay that examines in vivo tissues to reflect how chemicals are absorbed, excreted, distributed, and metabolized). This endpoint provides detailed genotoxicity data associated to a chemical.", + "properties": { + "id": { + "type": "integer", + "format": "int32" + }, + "assayCategory": { + "type": "string", + "description": "Category of assay: in vitro or in vivo", + "maxLength": 45, + "minLength": 0 + }, + "assayCode": { + "type": "string", + "maxLength": 45, + "minLength": 0 + }, + "assayPotency": { + "type": "integer", + "format": "int32", + "maximum": 45, + "minimum": 0 + }, + "assayResult": { + "type": "string", + "description": "Result in assay (positive, negative, or other)", + "maxLength": 45, + "minLength": 0 + }, + "assayType": { + "type": "string", + "description": "Type of genotoxicity assay", + "maxLength": 255, + "minLength": 0 + }, + "assayTypeStandard": { + "type": "string", + "maxLength": 255, + "minLength": 0 + }, + "chemicalId": { + "type": "string", + "maxLength": 255, + "minLength": 0 + }, + "clowderDocId": { + "type": "string", + "maxLength": 65, + "minLength": 0 + }, + "comment": { + "type": "string" + }, + "cytotoxicity": { + "type": "string", + "maxLength": 255, + "minLength": 0 + }, + "dataQuality": { + "type": "integer", + "format": "int32", + "maximum": 45, + "minimum": 0 + }, + "documentNumber": { + "type": "integer", + "format": "int32", + "maximum": 45, + "minimum": 0 + }, + "documentSource": { + "type": "string", + "maxLength": 45, + "minLength": 0 + }, + "doseResponse": { + "type": "string", + "maxLength": 45, + "minLength": 0 + }, + "dtxsid": { + "type": "string", + "description": "Distributed Structure-Searchable Toxicity (DSSTox) id", + "maxLength": 255, + "minLength": 0 + }, + "duration": { + "type": "integer", + "format": "int32", + "maximum": 45, + "minimum": 0 + }, + "genetoxCall": { + "type": "string", + "maxLength": 255, + "minLength": 0 + }, + "genetoxDetailsId": { + "type": "integer", + "format": "int32" + }, + "genetoxNote": { + "type": "string", + "maxLength": 255, + "minLength": 0 + }, + "genetoxResults": { + "type": "string", + "maxLength": 255, + "minLength": 0 + }, + "genetoxSummaryId": { + "type": "integer", + "format": "int32" + }, + "glp": { + "type": "integer", + "format": "int32" + }, + "guideline": { + "type": "string" + }, + "index": { + "type": "string" + }, + "metabolicActivation": { + "type": "string", + "description": "Indicator if assay included metabolic activation", + "maxLength": 45, + "minLength": 0 + }, + "micronucleus": { + "type": "string" + }, + "panelReport": { + "type": "string", + "maxLength": 255, + "minLength": 0 + }, + "protocolEra": { + "type": "string", + "maxLength": 45, + "minLength": 0 + }, + "reference": { + "type": "string", + "maxLength": 1024, + "minLength": 0 + }, + "referenceUrl": { + "type": "string", + "maxLength": 255, + "minLength": 0 + }, + "reportsNeg": { + "type": "string" + }, + "reportsOther": { + "type": "string" + }, + "reportsPos": { + "type": "string" + }, + "sex": { + "type": "string", + "maxLength": 45, + "minLength": 0 + }, + "source": { + "type": "string", + "description": "Originator of source data", + "maxLength": 45, + "minLength": 0 + }, + "species": { + "type": "string", + "description": "Species of the animal test subject used in a study", + "maxLength": 45, + "minLength": 0 + }, + "strain": { + "type": "string", + "description": "Intraspecific description of group of animals used in a study; generally, a stock of animals that share a uniform morphological or physiological character, or group that is genetically uniform", + "maxLength": 255, + "minLength": 0 + }, + "title": { + "type": "string", + "maxLength": 1024, + "minLength": 0 + }, + "useme": { + "type": "integer", + "format": "int64", + "description": "Year in which the study was reported as finished" + }, + "year": { + "type": "integer", + "format": "int32", + "description": "Year in which the study was reported as finished" + } + }, + "required": [ + "id" + ] + }, + "CancerSummary": { + "type": "object", + "description": "A carcinogen is a substance that may cause cancer and pose a health hazard. Carcinogens are subject to specific controls and regulations. National and international health agencies evaluate new and existing chemicals to determine if they are likely to be carcinogens through a process called cancer hazard identification. This process combines human and animal data with supporting evidence to characterize the weight-of-evidence (WOE) regarding the agent's potential as a human carcinogen. The general categories recognized by the guidelines are carcinogenic to humans, likely to be carcinogenic to humans, and suggestive evidence of carcinogenic potential. This endpoint provides summary-level cancer data associated to a chemical.", + "properties": { + "id": { + "type": "integer", + "format": "int32" + }, + "dtxsid": { + "type": "string", + "description": "Distributed Structure-Searchable Toxicity (DSSTox) id", + "maxLength": 255, + "minLength": 0 + }, + "source": { + "type": "string", + "description": "Originator of source data", + "maxLength": 255, + "minLength": 0 + }, + "exposureRoute": { + "type": "string", + "description": "Path by which test substance was administered to animal. Options include oral, dermal, inhalation, injection, or other", + "maxLength": 255, + "minLength": 0 + }, + "cancerCall": { + "type": "string", + "description": "Annotation indicating level of carcinogenicity", + "maxLength": 255, + "minLength": 0 + }, + "url": { + "type": "string", + "description": "URL for source data", + "maxLength": 255, + "minLength": 0 + } + }, + "required": [ + "id" + ] + }, + "ToxRefSummary": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "studyId": { + "type": "integer", + "format": "int32", + "description": "A unique numeric identifier for each study in the database." + }, + "dtxsid": { + "type": "string", + "description": "Unique identifier from DSSTox", + "maxLength": 45, + "minLength": 0 + }, + "casrn": { + "type": "string", + "description": "Curated casrn from DSSTOX chemical curation", + "maxLength": 255, + "minLength": 0 + }, + "name": { + "type": "string", + "description": "Curated chemical name from DSSTOX chemical curation", + "maxLength": 255, + "minLength": 0 + }, + "studySource": { + "type": "string", + "description": "Organization that provided or authored the document for curation.", + "maxLength": 255, + "minLength": 0 + }, + "studySourceId": { + "type": "string", + "description": "Unique document identifier provided by the study source.", + "maxLength": 255, + "minLength": 0 + }, + "citation": { + "type": "string", + "description": "Citation in source document", + "maxLength": 1024, + "minLength": 0 + }, + "studyYear": { + "type": "integer", + "format": "int32" + }, + "studyType": { + "type": "string", + "description": "Classification to describe animal toxicity testing that was conducted. Based on either dose period, subjects involved, or measured effects of interest, study types include: ACU (acute): Dose period typically a day or less. Excludes developmental and neurological studies.; SAC (subacute): Dose period is typically 21-28 days. Excludes developmental and neurological studies.; SUB (subchronic): Dose period is typically 13 weeks, but may be as long as 6 months. Excludes developmental and neurological studies.; CHR (chronic): Dose period is typically 12, 18, or 24 months (generally any dosing lasting a year or longer). Excludes developmental and neurological studies.; DEV (developmental): Gestational (in utero) dose period. Sacrificed prior to delivery.; MGR (multigenerational reproductive): Dose period begins in adolescent F0 males and females and continues until terminal generation. At least some of the litters deliver their pups, some may be sacrificed prior to delivery.; NEU (neurological): Study contains functional observation battery or other battery of behavioral testing that occurs during or after dosing. Pathology has specific interest in the brain (i.e. regions, morphology, biochemistry, et cetera). excludes developmental studies; DNT (developmental neurotoxicity): dose period occurs anytime during development (i.e. in utero, lactational, adolescent [after weaning, before adulthood]). Study contains functional observation battery or other battery of behavioral testing that occurs during or after dosing, typically during adulthood. Pathology has specific interest in the brain (i.e. regions, morphology, biochemistry, etc.)", + "maxLength": 255, + "minLength": 0 + }, + "studyTypeGuideline": { + "type": "string", + "description": "Description that combines the study_type and guideline name for a study.", + "maxLength": 255, + "minLength": 0 + }, + "species": { + "type": "string", + "description": "Species of the animal test subject used in a study.", + "maxLength": 255, + "minLength": 0 + }, + "strainGroup": { + "type": "string", + "description": "Descriptive category for a group of test animals that is more general than the strain. ", + "maxLength": 255, + "minLength": 0 + }, + "strain": { + "type": "string", + "description": "Intraspecific description of group of animals used in a study; generally, a stock of animals that share a uniform morphological or physiological character, or group that is genetically uniform.", + "maxLength": 255, + "minLength": 0 + }, + "adminRoute": { + "type": "string", + "description": "Path by which test substance was administered to animal. Options include oral, dermal, inhalation, injection, or other.", + "maxLength": 255, + "minLength": 0 + }, + "adminMethod": { + "type": "string", + "description": "Specific path by which the test substance was administered via the administration route. Examples include capsule, diet, gavage, or topical.", + "maxLength": 255, + "minLength": 0 + }, + "doseStart": { + "type": "integer", + "format": "int32", + "description": "Time during an animal's life that the administration of a test substance began." + }, + "doseStartUnit": { + "type": "string", + "description": "Unit of time associated with the start of the dose (dose_start).", + "maxLength": 255, + "minLength": 0 + }, + "doseEnd": { + "type": "integer", + "format": "int32", + "description": "Time during an animal's life that the administration of a test substance stopped." + }, + "doseEndUnit": { + "type": "string", + "description": "Unit of time associated with the end of the dose (dose_end).", + "maxLength": 255, + "minLength": 0 + }, + "exportDate": { + "type": "string", + "format": "date", + "description": "Date view of ToxRefDB data was created for API" + }, + "version": { + "type": "string", + "description": "Version of ToxRefDB data" + } + }, + "required": [ + "id" + ] + }, + "ToxRefObs": { + "type": "object", + "description": "Export of all observations and endpoint observation status according to a relevant guideline profile for the chemicals, studies, or study types listed in the input. Given ToxRefDB curations are guideline studies with specific testing requirements, guideline profiles are used to populate a list of observations that should be reported and tested within the study, i.e. endpoint observation status. Endpoint Observation status enables automated distinction of true negatives (i.e. tested with no effect observed) and better understanding of false negative (i.e. missing) effects.", + "properties": { + "id": { + "type": "integer", + "format": "int32" + }, + "studyId": { + "type": "integer", + "format": "int32", + "description": "Autoincremented unique numeric identifier for each study in ToxRefDB" + }, + "dtxsid": { + "type": "string", + "description": "Identifier assigned through DSSTox chemical curation", + "maxLength": 45, + "minLength": 0 + }, + "casrn": { + "type": "string", + "description": "Curated casrn from DSSTOX chemical curation", + "maxLength": 255, + "minLength": 0 + }, + "name": { + "type": "string", + "description": "Curated chemical name from DSSTOX chemical curation", + "maxLength": 255, + "minLength": 0 + }, + "studyType": { + "type": "string", + "description": "Classification to describe animal toxicity testing that was conducted. Based on either dose period, subjects involved, or measured effects of interest, study types include: ACU (acute): Dose period typically a day or less. Excludes developmental and neurological studies.; SAC (subacute): Dose period is typically 21-28 days. Excludes developmental and neurological studies.; SUB (subchronic): Dose period is typically 13 weeks, but may be as long as 6 months. Excludes developmental and neurological studies.; CHR (chronic): Dose period is typically 12, 18, or 24 months (generally any dosing lasting a year or longer). Excludes developmental and neurological studies.; DEV (developmental): Gestational (in utero) dose period. Sacrificed prior to delivery.; MGR (multigenerational reproductive): Dose period begins in adolescent F0 males and females and continues until terminal generation. At least some of the litters deliver their pups, some may be sacrificed prior to delivery.; NEU (neurological): Study contains functional observation battery or other battery of behavioral testing that occurs during or after dosing. Pathology has specific interest in the brain (i.e. regions, morphology, biochemistry, et cetera). excludes developmental studies; DNT (developmental neurotoxicity): dose period occurs anytime during development (i.e. in utero, lactational, adolescent [after weaning, before adulthood]). Study contains functional observation battery or other battery of behavioral testing that occurs during or after dosing, typically during adulthood. Pathology has specific interest in the brain (i.e. regions, morphology, biochemistry, etc.)", + "maxLength": 255, + "minLength": 0 + }, + "guidelineNumber": { + "type": "string", + "description": "Number associated with the guideline.OPP DERs follow the Series 870 - Health Effects Test Guidelines.", + "maxLength": 64, + "minLength": 0 + }, + "guidelineName": { + "type": "string", + "description": "Name of guideline, such as the particular Office of Chemical Safety and Pollution Prevention (OCSPP) guideline or NTP specifications.", + "maxLength": 512, + "minLength": 0 + }, + "endpointCategory": { + "type": "string", + "description": "The broadest descriptive term for an endpoint. Possible endpoint categories include: systemic, developmental, reproductive, and cholinesterase.", + "maxLength": 255, + "minLength": 0 + }, + "endpointType": { + "type": "string", + "description": "The subcategory for endpoint_category, which is more descriptive for a particular endpoint (e.g. pathology gross, clinical chemistry, reproductive performance, etc.)", + "maxLength": 255, + "minLength": 0 + }, + "endpointTarget": { + "type": "string", + "description": "More specific description than endpoint_type, often indicating where or how the sample was collected to supply data for a particular endpoint. Target may describe an organ, tissue, metabolite or protein measured.", + "maxLength": 255, + "minLength": 0 + }, + "status": { + "type": "string", + "description": "The status regarding whether or not an endpoint was required, recommended, triggered, not required, or mentioned by the study's most closely related guideline. Assumes that an endpoint was tested if the guideline the study adheres to requires that endpoint to be tested.", + "maxLength": 64, + "minLength": 0 + }, + "defaultStatus": { + "type": "boolean", + "description": "The status regarding whether or not an endpoint was tested and reported in a study. Assumes that an endpoint was tested if the guideline the study adheres to requires that endpoint to be tested." + }, + "testedStatus": { + "type": "boolean", + "description": "Indicates if an endpoint was tested (1) or not tested (0). If an endpoint was tested, it was examined or measured in the study." + }, + "reportedStatus": { + "type": "boolean", + "description": "Indicates if an endpoint was reported (1) or not reported (0). If an endpoint was reported, it appears somewhere in the text of the report." + }, + "exportDate": { + "type": "string", + "format": "date", + "description": "Date view of ToxRefDB data was created for API" + }, + "version": { + "type": "string", + "description": "Version of ToxRefDB data" + } + }, + "required": [ + "id" + ] + }, + "ToxRefEffects": { + "type": "object", + "description": "Export of all extracted dose-treatment group-effect information from ToxRefDB for the chemicals, studies, or study types listed in the input. This view is available as an enhanced data sheet from batch search on the CompTox Chemicals Dashboard. Data from ToxRefDB is also summarized in ToxValDB, including inferred NEL and NOAEL effect levels based on the reported LEL and LOAEL, respectively.", + "properties": { + "id": { + "type": "integer", + "format": "int32" + }, + "studyId": { + "type": "integer", + "format": "int32", + "description": "A unique numeric identifier for each study in the database." + }, + "dtxsid": { + "type": "string", + "description": "Unique identifier from DSSTox", + "maxLength": 45, + "minLength": 0 + }, + "casrn": { + "type": "string", + "description": "Curated casrn from DSSTOX chemical curation", + "maxLength": 255, + "minLength": 0 + }, + "name": { + "type": "string", + "description": "Curated chemical name from DSSTOX chemical curation", + "maxLength": 255, + "minLength": 0 + }, + "studySource": { + "type": "string", + "description": "Organization that provided or authored the document for curation.", + "maxLength": 255, + "minLength": 0 + }, + "studySourceId": { + "type": "string", + "description": "Unique document identifier provided by the study source.", + "maxLength": 255, + "minLength": 0 + }, + "citation": { + "type": "string", + "description": "Citation in source document", + "maxLength": 1024, + "minLength": 0 + }, + "studyYear": { + "type": "integer", + "format": "int32" + }, + "studyType": { + "type": "string", + "description": "Classification to describe animal toxicity testing that was conducted. Based on either dose period, subjects involved, or measured effects of interest, study types include: ACU (acute): Dose period typically a day or less. Excludes developmental and neurological studies.; SAC (subacute): Dose period is typically 21-28 days. Excludes developmental and neurological studies.; SUB (subchronic): Dose period is typically 13 weeks, but may be as long as 6 months. Excludes developmental and neurological studies.; CHR (chronic): Dose period is typically 12, 18, or 24 months (generally any dosing lasting a year or longer). Excludes developmental and neurological studies.; DEV (developmental): Gestational (in utero) dose period. Sacrificed prior to delivery.; MGR (multigenerational reproductive): Dose period begins in adolescent F0 males and females and continues until terminal generation. At least some of the litters deliver their pups, some may be sacrificed prior to delivery.; NEU (neurological): Study contains functional observation battery or other battery of behavioral testing that occurs during or after dosing. Pathology has specific interest in the brain (i.e. regions, morphology, biochemistry, et cetera). excludes developmental studies; DNT (developmental neurotoxicity): dose period occurs anytime during development (i.e. in utero, lactational, adolescent [after weaning, before adulthood]). Study contains functional observation battery or other battery of behavioral testing that occurs during or after dosing, typically during adulthood. Pathology has specific interest in the brain (i.e. regions, morphology, biochemistry, etc.)", + "maxLength": 255, + "minLength": 0 + }, + "studyTypeGuideline": { + "type": "string", + "description": "Description that combines the study_type and guideline name for a study.", + "maxLength": 255, + "minLength": 0 + }, + "species": { + "type": "string", + "description": "Species of the animal test subject used in a study.", + "maxLength": 255, + "minLength": 0 + }, + "strainGroup": { + "type": "string", + "description": "Descriptive category for a group of test animals that is more general than the strain. ", + "maxLength": 255, + "minLength": 0 + }, + "strain": { + "type": "string", + "description": "Intraspecific description of group of animals used in a study; generally, a stock of animals that share a uniform morphological or physiological character, or group that is genetically uniform.", + "maxLength": 255, + "minLength": 0 + }, + "adminRoute": { + "type": "string", + "description": "Path by which test substance was administered to animal. Options include oral, dermal, inhalation, injection, or other.", + "maxLength": 255, + "minLength": 0 + }, + "adminMethod": { + "type": "string", + "description": "Specific path by which the test substance was administered via the administration route. Examples include capsule, diet, gavage, or topical.", + "maxLength": 255, + "minLength": 0 + }, + "doseDuration": { + "type": "integer", + "format": "int32", + "description": "Amount of time a group is dosed. This varies within studies depending on the dose period of a particular treatment group." + }, + "doseDurationUnit": { + "type": "string", + "description": "Unit of time associated with the dose duration. Typically in days or months.", + "maxLength": 16, + "minLength": 0 + }, + "doseStart": { + "type": "integer", + "format": "int32", + "description": "Time during an animal's life that the administration of a test substance began." + }, + "doseStartUnit": { + "type": "string", + "description": "Unit of time associated with the start of the dose (dose_start).", + "maxLength": 255, + "minLength": 0 + }, + "doseEnd": { + "type": "integer", + "format": "int32", + "description": "Time during an animal's life that the administration of a test substance stopped." + }, + "doseEndUnit": { + "type": "string", + "description": "Unit of time associated with the end of the dose (dose_end).", + "maxLength": 255, + "minLength": 0 + }, + "dosePeriod": { + "type": "string", + "description": "Period within a group's lifetime that the animals were dosed and the sample for an endpoint's data was taken (when the animals were sacrificed).", + "maxLength": 32, + "minLength": 0 + }, + "doseLevel": { + "type": "integer", + "format": "int32", + "description": "Numeric rank indicating the level of dose administered to test animals, with lower dose levels indicating lower concentrations of a chemical (e.g., 0 = vehicle, 1 = lowest dose, etc.). The dose level for some studies may be staggered since concentrations may vary by sex (e.g, male treatment group: 0 = vehicle, 1 = lowest dose, 3 = second lowest dose, etc.)." + }, + "conc": { + "type": "number", + "format": "double", + "description": "Concentration of a test chemical, typically reported in ppm within the exposure matrix (e.g., feed or water)." + }, + "concUnit": { + "type": "string", + "description": "Unit associated with a concentration of a test chemical, typically reported as ppm.", + "maxLength": 255, + "minLength": 0 + }, + "vehicle": { + "type": "string", + "description": "The media used in administration of the chemical.", + "maxLength": 255, + "minLength": 0 + }, + "doseComment": { + "type": "string", + "description": "NULL if no additional comment needed. Field can be used to explain any differences in dosing over the dosing interval and/or clarifying comments on how the dose was administered.", + "maxLength": 1024, + "minLength": 0 + }, + "doseAdjusted": { + "type": "number", + "description": "The amount of the chemical administered in mg/kg of body weight/day (mg/kg/day). This value is typically different between male and female groups receiving the same dose concentration (conc) due to differences in bodyweight. If dose_adjusted values were not provided in a study, then they were calculated using species scaling factors (FAO/WHO, 2000)." + }, + "doseAdjustedUnit": { + "type": "string", + "description": "Unit associated with the adjusted dose of a chemical, typically reported in mg/kg/day.", + "maxLength": 32, + "minLength": 0 + }, + "sex": { + "type": "string", + "description": "Gender of a test animal. The gender of fetal groups is denoted as MF for both males and females.", + "maxLength": 8, + "minLength": 0 + }, + "generation": { + "type": "string", + "description": "Generation a test animal belongs to. The F0 generation is the first generation mating group for MGR studies and is the default for non-reproductive studies (CHR, SUB, SAC). F1 is the second generation mating group, selected from either F1a or F1b litters. F2 is the third generation mating group, selected from either F2a or F2b litters. F1a and F1b are the first and second litter groups produced by F0 matings, F2a and F2b are the first and second litter groups produced by F1 matings, and F3a and F3b are the first and second litter groups produced by F2 matings. The fetal generation is the group produced by F0 matings in DEV studies, and are typically removed from a female via cesarean section in DEV studies.", + "maxLength": 16, + "minLength": 0 + }, + "lifeStage": { + "type": "string", + "description": "Stage of life that a measurement was taken. CHR, SUB, and SAC studies typically only have adult for life_stage, whereas DEV and MGR studies will always be characterized by multiple life stages. The different life stages in the database include: fetal, juvenile, adult, adult-pregnancy and pregnancy.", + "maxLength": 32, + "minLength": 0 + }, + "numAnimals": { + "type": "number", + "description": "Number of animals per treatment group" + }, + "tgComment": { + "type": "string", + "description": "NULL if no additional comment needed; contains information that the extractor/curator found helpful in describing issues related to a treatment-group (e.g. animals dosed via capsule so concentration not reported, added recovery groups, etc.). ", + "maxLength": 1024, + "minLength": 0 + }, + "endpointCategory": { + "type": "string", + "description": "The broadest descriptive term for an endpoint. Possible endpoint categories include: systemic, developmental, reproductive, and cholinesterase.", + "maxLength": 255, + "minLength": 0 + }, + "endpointType": { + "type": "string", + "description": "The subcategory for endpoint_category, which is more descriptive for a particular endpoint (e.g. pathology gross, clinical chemistry, reproductive performance, etc.)", + "maxLength": 255, + "minLength": 0 + }, + "endpointTarget": { + "type": "string", + "description": "More specific description than endpoint_type, often indicating where or how the sample was collected to supply data for a particular endpoint. Target may describe an organ, tissue, metabolite or protein measured.", + "maxLength": 255, + "minLength": 0 + }, + "effectDesc": { + "type": "string", + "description": "More specific description for an effect than endpoint_category, usually detailing a specific condition associated with an endpoint_target (e.g. dysplasia, atrophy, necrosis, etc.).", + "maxLength": 255, + "minLength": 0 + }, + "effectDescFree": { + "type": "string", + "description": "Brief verbatim text from study file that was entered if the effect description differed from predetermined endpoint terminology.", + "maxLength": 255, + "minLength": 0 + }, + "cancerRelated": { + "type": "boolean", + "description": "Indicates if effect is considered cancer related (1) or not." + }, + "targetSite": { + "type": "string", + "description": "A more specific description than effect_target. Can describe a specific tissue within an organ, type of cell, etc.", + "maxLength": 64, + "minLength": 0 + }, + "direction": { + "type": "integer", + "format": "int32", + "description": "Description of the net change across all doses that indicates whether the numerical data increased, decreased, or stayed the same. Also can be used to describe effects that did not have numerical data, but were still described in the study source." + }, + "effectComment": { + "type": "string", + "description": "NULL if no additional comment needed; contains information that the extractor/curator found helpful in describing issues related to a treatment-group-effect (e.g. units not reported, effect only reported for certain treatment groups, etc.).", + "maxLength": 1024, + "minLength": 0 + }, + "treatmentRelated": { + "type": "boolean", + "description": "Boolean description for an effect by dose treatment group. “TRUE” indicates there was a statistically significant difference from the control group for the effect; “FALSE” indicates there was no difference from control group. The highest dose level at which no significant observable adverse effects were observed corresponds to the no effect level (NEL). The lowest effect level (LEL) can be inferred by treatment related effects." + }, + "criticalEffect": { + "type": "boolean", + "description": "Boolean description for an effect by dose treatment group. “TRUE” corresponds to a toxic or adverse effect denoted in the study summary or via expert judgement using a weight-of-evidence approach. “FALSE” indicates that although an effect is produced at this level, it is not considered adverse, nor immediate precursors to specific adverse effects. If there are several critical effects, the no observed adverse effect level (NOAEL) is determined from the highest dose level without critical effects. The lowest dose level at which the critical effect was observed in a study is the lowest observed adverse effect level (LOAEL.)" + }, + "sampleSize": { + "type": "string", + "description": "Number of animals used for an examination for a particular effect.", + "maxLength": 8, + "minLength": 0 + }, + "effectVal": { + "type": "number", + "format": "double", + "description": "Numeric value of a measured effect, can be continuous or dichotomous (incidence) data." + }, + "effectValUnit": { + "type": "string", + "description": "Unit associated with the effect value.", + "maxLength": 128, + "minLength": 0 + }, + "effectVar": { + "type": "number", + "format": "double", + "description": "Measurement of the variance for a set of data associated with a measured effect, generally reported as the standard deviation (SD) or standard error (SE)." + }, + "effectVarType": { + "type": "string", + "description": "Name of the variance metric used to determine the effect variance, typically the standard deviation (SD) or standard error (SE). Other effect_var types include: interquartile range, 95% confidence limit, and none.", + "maxLength": 32, + "minLength": 0 + }, + "time": { + "type": "number", + "format": "double", + "description": "Numeric value associated with the duration of the exposure at which a particular effect was measured or observed, typically reported in hours, days, weeks, or months." + }, + "timeUnit": { + "type": "string", + "description": " Unit associated with the duration of the exposure at which a particular effect was measured or observed, typically reported in hours, days, weeks, or months.", + "maxLength": 64, + "minLength": 0 + }, + "noQuantDataReported": { + "type": "boolean", + "description": "Indicates if qualitative (1) or quantitative (0) effect data was reported." + }, + "exportDate": { + "type": "string", + "format": "date", + "description": "Date view of ToxRefDB data was created for API" + }, + "version": { + "type": "string", + "description": "Version of ToxRefDB data" + } + }, + "required": [ + "id" + ] + }, + "ToxRefData": { + "type": "object", + "description": "Export of all extracted dose-treatment group-effect information as well as doses not eliciting effects from ToxRefDB for the chemicals, studies, or study types listed in the input. Data from ToxRefDB is also summarized in ToxValDB, including inferred NEL and NOAEL effect levels based on the reported LEL and LOAEL, respectively.", + "properties": { + "id": { + "type": "integer", + "format": "int32" + }, + "studyId": { + "type": "integer", + "format": "int32", + "description": "A unique numeric identifier for each study in the database." + }, + "dtxsid": { + "type": "string", + "description": "Unique identifier from DSSTox", + "maxLength": 45, + "minLength": 0 + }, + "casrn": { + "type": "string", + "description": "Curated casrn from DSSTOX chemical curation", + "maxLength": 255, + "minLength": 0 + }, + "name": { + "type": "string", + "description": "Curated chemical name from DSSTOX chemical curation", + "maxLength": 255, + "minLength": 0 + }, + "studySource": { + "type": "string", + "description": "Organization that provided or authored the document for curation.", + "maxLength": 255, + "minLength": 0 + }, + "studySourceId": { + "type": "string", + "description": "Unique document identifier provided by the study source.", + "maxLength": 255, + "minLength": 0 + }, + "citation": { + "type": "string", + "description": "Citation in source document", + "maxLength": 1024, + "minLength": 0 + }, + "studyYear": { + "type": "integer", + "format": "int32" + }, + "studyType": { + "type": "string", + "description": "Classification to describe animal toxicity testing that was conducted. Based on either dose period, subjects involved, or measured effects of interest, study types include: ACU (acute): Dose period typically a day or less. Excludes developmental and neurological studies.; SAC (subacute): Dose period is typically 21-28 days. Excludes developmental and neurological studies.; SUB (subchronic): Dose period is typically 13 weeks, but may be as long as 6 months. Excludes developmental and neurological studies.; CHR (chronic): Dose period is typically 12, 18, or 24 months (generally any dosing lasting a year or longer). Excludes developmental and neurological studies.; DEV (developmental): Gestational (in utero) dose period. Sacrificed prior to delivery.; MGR (multigenerational reproductive): Dose period begins in adolescent F0 males and females and continues until terminal generation. At least some of the litters deliver their pups, some may be sacrificed prior to delivery.; NEU (neurological): Study contains functional observation battery or other battery of behavioral testing that occurs during or after dosing. Pathology has specific interest in the brain (i.e. regions, morphology, biochemistry, et cetera). excludes developmental studies; DNT (developmental neurotoxicity): dose period occurs anytime during development (i.e. in utero, lactational, adolescent [after weaning, before adulthood]). Study contains functional observation battery or other battery of behavioral testing that occurs during or after dosing, typically during adulthood. Pathology has specific interest in the brain (i.e. regions, morphology, biochemistry, etc.)", + "maxLength": 255, + "minLength": 0 + }, + "studyTypeGuideline": { + "type": "string", + "description": "Description that combines the study_type and guideline name for a study.", + "maxLength": 255, + "minLength": 0 + }, + "species": { + "type": "string", + "description": "Species of the animal test subject used in a study.", + "maxLength": 255, + "minLength": 0 + }, + "strainGroup": { + "type": "string", + "description": "Descriptive category for a group of test animals that is more general than the strain. ", + "maxLength": 255, + "minLength": 0 + }, + "strain": { + "type": "string", + "description": "Intraspecific description of group of animals used in a study; generally, a stock of animals that share a uniform morphological or physiological character, or group that is genetically uniform.", + "maxLength": 255, + "minLength": 0 + }, + "adminRoute": { + "type": "string", + "description": "Path by which test substance was administered to animal. Options include oral, dermal, inhalation, injection, or other.", + "maxLength": 255, + "minLength": 0 + }, + "adminMethod": { + "type": "string", + "description": "Specific path by which the test substance was administered via the administration route. Examples include capsule, diet, gavage, or topical.", + "maxLength": 255, + "minLength": 0 + }, + "doseDuration": { + "type": "integer", + "format": "int32", + "description": "Amount of time a group is dosed. This varies within studies depending on the dose period of a particular treatment group." + }, + "doseDurationUnit": { + "type": "string", + "description": "Unit of time associated with the dose duration. Typically in days or months.", + "maxLength": 16, + "minLength": 0 + }, + "doseStart": { + "type": "integer", + "format": "int32", + "description": "Time during an animal's life that the administration of a test substance began." + }, + "doseStartUnit": { + "type": "string", + "description": "Unit of time associated with the start of the dose (dose_start).", + "maxLength": 255, + "minLength": 0 + }, + "doseEnd": { + "type": "integer", + "format": "int32", + "description": "Time during an animal's life that the administration of a test substance stopped." + }, + "doseEndUnit": { + "type": "string", + "description": "Unit of time associated with the end of the dose (dose_end).", + "maxLength": 255, + "minLength": 0 + }, + "dosePeriod": { + "type": "string", + "description": "Period within a group's lifetime that the animals were dosed and the sample for an endpoint's data was taken (when the animals were sacrificed).", + "maxLength": 32, + "minLength": 0 + }, + "doseLevel": { + "type": "integer", + "format": "int32", + "description": "Numeric rank indicating the level of dose administered to test animals, with lower dose levels indicating lower concentrations of a chemical (e.g., 0 = vehicle, 1 = lowest dose, etc.). The dose level for some studies may be staggered since concentrations may vary by sex (e.g, male treatment group: 0 = vehicle, 1 = lowest dose, 3 = second lowest dose, etc.)." + }, + "conc": { + "type": "number", + "format": "double", + "description": "Concentration of a test chemical, typically reported in ppm within the exposure matrix (e.g., feed or water)." + }, + "concUnit": { + "type": "string", + "description": "Unit associated with a concentration of a test chemical, typically reported as ppm.", + "maxLength": 255, + "minLength": 0 + }, + "vehicle": { + "type": "string", + "description": "The media used in administration of the chemical.", + "maxLength": 255, + "minLength": 0 + }, + "doseComment": { + "type": "string", + "description": "NULL if no additional comment needed. Field can be used to explain any differences in dosing over the dosing interval and/or clarifying comments on how the dose was administered.", + "maxLength": 1024, + "minLength": 0 + }, + "doseAdjusted": { + "type": "number", + "description": "The amount of the chemical administered in mg/kg of body weight/day (mg/kg/day). This value is typically different between male and female groups receiving the same dose concentration (conc) due to differences in bodyweight. If dose_adjusted values were not provided in a study, then they were calculated using species scaling factors (FAO/WHO, 2000)." + }, + "doseAdjustedUnit": { + "type": "string", + "description": "Unit associated with the adjusted dose of a chemical, typically reported in mg/kg/day.", + "maxLength": 32, + "minLength": 0 + }, + "sex": { + "type": "string", + "description": "Gender of a test animal. The gender of fetal groups is denoted as MF for both males and females.", + "maxLength": 8, + "minLength": 0 + }, + "generation": { + "type": "string", + "description": "Generation a test animal belongs to. The F0 generation is the first generation mating group for MGR studies and is the default for non-reproductive studies (CHR, SUB, SAC). F1 is the second generation mating group, selected from either F1a or F1b litters. F2 is the third generation mating group, selected from either F2a or F2b litters. F1a and F1b are the first and second litter groups produced by F0 matings, F2a and F2b are the first and second litter groups produced by F1 matings, and F3a and F3b are the first and second litter groups produced by F2 matings. The fetal generation is the group produced by F0 matings in DEV studies, and are typically removed from a female via cesarean section in DEV studies.", + "maxLength": 16, + "minLength": 0 + }, + "lifeStage": { + "type": "string", + "description": "Stage of life that a measurement was taken. CHR, SUB, and SAC studies typically only have adult for life_stage, whereas DEV and MGR studies will always be characterized by multiple life stages. The different life stages in the database include: fetal, juvenile, adult, adult-pregnancy and pregnancy.", + "maxLength": 32, + "minLength": 0 + }, + "numAnimals": { + "type": "number", + "description": "Number of animals per treatment group" + }, + "tgComment": { + "type": "string", + "description": "NULL if no additional comment needed; contains information that the extractor/curator found helpful in describing issues related to a treatment-group (e.g. animals dosed via capsule so concentration not reported, added recovery groups, etc.). ", + "maxLength": 1024, + "minLength": 0 + }, + "endpointCategory": { + "type": "string", + "description": "The broadest descriptive term for an endpoint. Possible endpoint categories include: systemic, developmental, reproductive, and cholinesterase.", + "maxLength": 255, + "minLength": 0 + }, + "endpointType": { + "type": "string", + "description": "The subcategory for endpoint_category, which is more descriptive for a particular endpoint (e.g. pathology gross, clinical chemistry, reproductive performance, etc.)", + "maxLength": 255, + "minLength": 0 + }, + "endpointTarget": { + "type": "string", + "description": "More specific description than endpoint_type, often indicating where or how the sample was collected to supply data for a particular endpoint. Target may describe an organ, tissue, metabolite or protein measured.", + "maxLength": 255, + "minLength": 0 + }, + "effectDesc": { + "type": "string", + "description": "More specific description for an effect than endpoint_category, usually detailing a specific condition associated with an endpoint_target (e.g. dysplasia, atrophy, necrosis, etc.).", + "maxLength": 255, + "minLength": 0 + }, + "effectDescFree": { + "type": "string", + "description": "Brief verbatim text from study file that was entered if the effect description differed from predetermined endpoint terminology.", + "maxLength": 255, + "minLength": 0 + }, + "cancerRelated": { + "type": "boolean", + "description": "Indicates if effect is considered cancer related (1) or not." + }, + "targetSite": { + "type": "string", + "description": "A more specific description than effect_target. Can describe a specific tissue within an organ, type of cell, etc.", + "maxLength": 64, + "minLength": 0 + }, + "direction": { + "type": "integer", + "format": "int32", + "description": "Description of the net change across all doses that indicates whether the numerical data increased, decreased, or stayed the same. Also can be used to describe effects that did not have numerical data, but were still described in the study source." + }, + "effectComment": { + "type": "string", + "description": "NULL if no additional comment needed; contains information that the extractor/curator found helpful in describing issues related to a treatment-group-effect (e.g. units not reported, effect only reported for certain treatment groups, etc.).", + "maxLength": 1024, + "minLength": 0 + }, + "treatmentRelated": { + "type": "boolean", + "description": "Boolean description for an effect by dose treatment group. “TRUE” indicates there was a statistically significant difference from the control group for the effect; “FALSE” indicates there was no difference from control group. The highest dose level at which no significant observable adverse effects were observed corresponds to the no effect level (NEL). The lowest effect level (LEL) can be inferred by treatment related effects." + }, + "criticalEffect": { + "type": "boolean", + "description": "Boolean description for an effect by dose treatment group. “TRUE” corresponds to a toxic or adverse effect denoted in the study summary or via expert judgement using a weight-of-evidence approach. “FALSE” indicates that although an effect is produced at this level, it is not considered adverse, nor immediate precursors to specific adverse effects. If there are several critical effects, the no observed adverse effect level (NOAEL) is determined from the highest dose level without critical effects. The lowest dose level at which the critical effect was observed in a study is the lowest observed adverse effect level (LOAEL.)" + }, + "sampleSize": { + "type": "string", + "description": "Number of animals used for an examination for a particular effect.", + "maxLength": 8, + "minLength": 0 + }, + "effectVal": { + "type": "number", + "format": "double", + "description": "Numeric value of a measured effect, can be continuous or dichotomous (incidence) data." + }, + "effectValUnit": { + "type": "string", + "description": "Unit associated with the effect value.", + "maxLength": 128, + "minLength": 0 + }, + "effectVar": { + "type": "number", + "format": "double", + "description": "Measurement of the variance for a set of data associated with a measured effect, generally reported as the standard deviation (SD) or standard error (SE)." + }, + "effectVarType": { + "type": "string", + "description": "Name of the variance metric used to determine the effect variance, typically the standard deviation (SD) or standard error (SE). Other effect_var types include: interquartile range, 95% confidence limit, and none.", + "maxLength": 32, + "minLength": 0 + }, + "time": { + "type": "number", + "format": "double", + "description": "Numeric value associated with the duration of the exposure at which a particular effect was measured or observed, typically reported in hours, days, weeks, or months." + }, + "timeUnit": { + "type": "string", + "description": " Unit associated with the duration of the exposure at which a particular effect was measured or observed, typically reported in hours, days, weeks, or months.", + "maxLength": 64, + "minLength": 0 + }, + "noQuantDataReported": { + "type": "boolean", + "description": "Indicates if qualitative (1) or quantitative (0) effect data was reported." + }, + "exportDate": { + "type": "string", + "format": "date", + "description": "Date view of ToxRefDB data was created for API" + }, + "version": { + "type": "string", + "description": "Version of ToxRefDB data" + } + }, + "required": [ + "id" + ] + }, + "Pprtv": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int32" + }, + "dtxsid": { + "type": "string", + "description": "Distributed Structure-Searchable Toxicity (DSSTox) id", + "maxLength": 45, + "minLength": 0 + }, + "pprtvSubstanceId": { + "type": "integer", + "format": "int32" + }, + "name": { + "type": "string" + }, + "casrn": { + "type": "string" + }, + "lastRevision": { + "type": "integer", + "format": "int32" + }, + "pprtvAssessment": { + "type": "string" + }, + "irisLink": { + "type": "string" + }, + "rfcValue": { + "type": "string" + }, + "rfdValue": { + "type": "string" + }, + "woe": { + "type": "string" + } + }, + "required": [ + "id" + ] + }, + "Iris": { + "type": "object", + "description": "Integrated Risk Information System (IRIS): EPA's IRIS Program identifies and characterizes the health hazards of chemicals found in the environment. Each IRIS assessment can cover a chemical, a group of related chemicals, or a complex mixture. IRIS assessments are an important source of toxicity information used by EPA, state and local health agencies, other federal agencies, and international health organizations.", + "properties": { + "dtxsid": { + "type": "string" + }, + "chemicalName": { + "type": "string" + }, + "casrn": { + "type": "string" + }, + "lastSignificantRevision": { + "type": "string", + "format": "date" + }, + "literatureScreeningReview": { + "type": "string" + }, + "criticalEffectsSystems": { + "type": "string" + }, + "rfdChronic": { + "type": "string" + }, + "rfdSubchronic": { + "type": "string" + }, + "rfcChronic": { + "type": "string" + }, + "rfcSubchronic": { + "type": "string" + }, + "tumorSite": { + "type": "string" + }, + "irisUrl": { + "type": "string" + } + }, + "required": [ + "dtxsid" + ] + }, + "Hawc": { + "type": "object", + "description": "EPA Health Assessment Workspace Collaborative (HAWC). EPA HAWC is an interactive, expert-driven, content management system for EPA health and environmental risk assessment programs that is intended to promote transparency, data usability, and understanding of the data and decisions supporting health and environmental assessments. Specifically, EPA HAWC is an application that allows the data and decisions supporting an assessment to be evaluated and managed in modules (e.g., study evaluation, summary study data) that can then be publicly accessed online.", + "properties": { + "id": { + "type": "integer", + "format": "int32" + }, + "name": { + "type": "string" + }, + "year": { + "type": "integer", + "format": "int32" + }, + "dtxsid": { + "type": "string" + }, + "ccdUrl": { + "type": "string" + }, + "hawcUrl": { + "type": "string" + } + }, + "required": [ + "id" + ] + }, + "CcdGenetoxDetail": { + "type": "object", + "properties": { + "year": { + "type": "integer", + "format": "int32" + }, + "source": { + "type": "string" + }, + "metabolicActivation": { + "type": "string" + }, + "species": { + "type": "string" + }, + "dtxsid": { + "type": "string" + }, + "assayCategory": { + "type": "string" + }, + "assayResult": { + "type": "string" + }, + "assayType": { + "type": "string" + }, + "strain": { + "type": "string" + } + } + }, + "Adme": { + "type": "object", + "description": "The information here describes toxicokinetics in humans. Values are 1) measured either in vitro or in vivo, 2) predicted from chemical properties using in silico tools, or 3) computed with mathematical models simulating toxicokinetics. Note: intrinsic hepatic clearance and fraction unbound in plasma values can have measured values listed, but these may be assumed from measured data using a surrogate species. The Data Source Species column identifies the measured data species source. We use these assumed measured values in calculations to estimate other outcomes, such as volume of distribution, PK half life, and steady-state plasma concentration. The in vitro measured values reflect the value curated for the open source R package “httk”. The computed values are generated with httk using the reported in vitro values. \"https://CRAN.R-project.org/package=httk\". The in vivo measured values are estimated from toxicokinetic concentration vs. time contained in the CvTdb (https://doi.org/10.1038/s41597-020-0455-1). In vivo estimates are calculated using R package “invivoPKfit” (https://github.com/USEPA/CompTox-ExpoCast-invivoPKfit)", + "properties": { + "id": { + "type": "integer", + "format": "int32" + }, + "dtxsid": { + "type": "string", + "description": "Distributed Structure-Searchable Toxicity (DSSTox) id" + }, + "description": { + "type": "string" + }, + "measured": { + "type": "string" + }, + "predicted": { + "type": "string" + }, + "unit": { + "type": "string", + "maxLength": 30, + "minLength": 0 + }, + "model": { + "type": "string" + }, + "reference": { + "type": "string" + }, + "percentile": { + "type": "string" + }, + "species": { + "type": "string" + }, + "dataSourceSpecies": { + "type": "string" + } + }, + "required": [ + "id" + ] + }, + "CcdADME": { + "type": "object", + "properties": { + "reference": { + "type": "string" + }, + "description": { + "type": "string" + }, + "label": { + "type": "string" + }, + "model": { + "type": "string" + }, + "dataSourceSpecies": { + "type": "string" + }, + "unit": { + "type": "string" + }, + "percentile": { + "type": "string" + }, + "measured": { + "type": "string" + }, + "species": { + "type": "string" + }, + "predicted": { + "type": "string" + }, + "dtxsid": { + "type": "string" + } + } + } + }, + "securitySchemes": { + "api_key": { + "type": "apiKey", + "description": "Each API request requires an api_key. Contact the CTX API Admin to request an API Key.", + "name": "x-api-key", + "in": "header" + } } -} + } +} \ No newline at end of file