fIVE API

This API allows access to fIVEDB (from In Vitro Experiments Data Base), a manually curated online database containing the quantitative data on human cells or cell lines obtained in vitro and ex vivo. Data processing includes the calculation of parameters suitable for cell process description via mathematical models. Important! In order to make a query, all parameters must be chosen from the database dictionaries.
More information: https://openapi-generator.tech
Contact Info: support@insysbio.com
Version: 1.0.0
BasePath:/api/v1
Apache 2.0
http://www.apache.org/licenses/LICENSE-2.0.html

Access

  1. OAuth AuthorizationUrl:https://5db.insysbio.com/oauth/tokenTokenUrl:
  2. APIKey KeyParamName:Authorization KeyInQuery:false KeyInHeader:true

Methods

[ Jump to Models ]

Table of Contents

DaughterCells

Modifiers

Parameters

PatientStates

ProcessTypes

Products

QueryData

QueryDataHeaders

Regulators

Stimulated

DaughterCells

Up 
get /daughter_cells
Return the list of daughter cells to be used in Query (optional parameter for query). Choosing of the daughter cells is available only for process "Differentiation". (daughterCellsGet)

Return type

array[DaughterCell]

Example data

Content-Type: application/json
[ {
  "name" : "Granulocytes",
  "id" : 10
}, {
  "name" : "Granulocytes",
  "id" : 10
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

successful operation

400

Invalid status value. This response appears when the required object does not exist in the DB.

Modifiers

Up 
get /modifiers
Return the list of modifiers to be used in Query (optional parameter for query). Modifiers are molecules which influence on regulators. (modifiersGet)

Return type

array[Modifier]

Example data

Content-Type: application/json
[ {
  "name" : "IL17",
  "id" : 10
}, {
  "name" : "IL17",
  "id" : 10
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

successful operation

400

Invalid status value. This response appears when the required object does not exist in the DB.

Parameters

Up 
get /parameters
Return the list of parameters to be used in Query (optional parameter for query). Parameters are calculated in fIVEDB and describe cell processes. (parametersGet)

Return type

array[Parameter]

Example data

Content-Type: application/json
[ {
  "name" : "kbase",
  "id" : 10
}, {
  "name" : "kbase",
  "id" : 10
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

successful operation

400

Invalid status value. This response appears when the required object does not exist in the DB.

PatientStates

Up 
get /patient_states
Return the list of Patient's states (disease names, severities or additional patients characteristics) to be used in Query (optional parameter for query). (patientStatesGet)

Return type

array[PatientState]

Example data

Content-Type: application/json
[ {
  "name" : "Healthy",
  "id" : 10
}, {
  "name" : "Healthy",
  "id" : 10
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

successful operation

400

Invalid status value. This response appears when the required object does not exist in the DB.

ProcessTypes

Up 
get /process_types
Return full list of the cell process types to be used in Query (optional parameter for query). (processTypesGet)

Return type

array[ProcessType]

Example data

Content-Type: application/json
[ {
  "name" : "Secretion",
  "id" : 10
}, {
  "name" : "Secretion",
  "id" : 10
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

successful operation

400

Invalid status value. This response appears when the required object does not exist in the DB.

Products

Up 
get /products
Return list of products (cytokines and others) secreted by cells to be used in Query (optional parameter for query). Choosing of the cell products are available only for process "Secretion". (productsGet)

Return type

array[Product]

Example data

Content-Type: application/json
[ {
  "name" : "IL6",
  "id" : 10
}, {
  "name" : "IL6",
  "id" : 10
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

successful operation

400

Invalid status value. This response appears when the required object does not exist in the DB.

QueryData

Up 
get /query_data
Return the list with query output according to parameters provided. There are a total of 11 parameters, where multiple inputs can be selected for all parameters, but currently, only the "OR" logic is supported. (queryDataGet)

Query parameters

process_type (required)
Query Parameter — default: null
parameter (required)
Query Parameter — default: null
cell_type (optional)
Query Parameter — default: null
stimulated (optional)
Query Parameter — default: null
patient_state (optional)
Query Parameter — default: null
product (optional)
Query Parameter — default: null
daughter (optional)
Query Parameter — default: null
regulator (optional)
Query Parameter — default: null
modifier (optional)
Query Parameter — default: null
wstatSwitch (optional)
Query Parameter — true - only weighted result or false - all data without weighted result default: null
headers (optional)
Query Parameter — comma separated list of params to output to result default: null

Return type

array[QueryData]

Example data

Content-Type: application/json
[ {
  "prm_val_unf" : "Unified Parameter value",
  "reg_con_unt" : "Regulator concentration unit",
  "prm_unt" : "Parameter unit",
  "dsp_type" : "Dispersion type",
  "exp_res" : "Experiment result type",
  "exp_val" : "Experimental value",
  "c_line" : "Cell line/primary cells",
  "ser_stmln" : "Stimulation",
  "r_name" : "Regulator",
  "r_name_db" : "Regulator DB name",
  "m_mw" : "Modifier Mw(kDa)",
  "prd_name" : "Cell product",
  "exp_u" : "Experiment time unit",
  "d_name" : "Patient’s state",
  "dt_name" : "Daughter cells",
  "exp_t" : "Experiment time",
  "t_name" : "Source of cells",
  "exp_val_unt" : "Experimental value unit",
  "ser_age" : "Age category",
  "mod_con" : "Modifier concentration",
  "reg_con" : "Regulator concentration",
  "prm_val" : "Parameter value",
  "avg_type" : "Average type",
  "r_mw" : "Regulator Mw(kDa)",
  "cell_con_unt" : "Initial cell concentration unit",
  "ser_comment" : "Commentary",
  "prd_name_db" : "Cell product DB name",
  "prm_name" : "Parameter",
  "ser_cm" : "Culture media",
  "n_val" : "N of in vitro experiments",
  "dsp_left" : "Dispersion left",
  "pmid" : "Article PMID",
  "dsp_right" : "Dispersion right",
  "mod_con_unt" : "Modifier concentration unit",
  "prd_mw" : "Product Mw(kDa)",
  "m_name" : "Modifier",
  "m_name_db" : "Modifier DB name",
  "ser_phc" : "Cell phenotype",
  "stm_cell" : "Stimulated cells",
  "cell_con" : "Initial cell concentration",
  "c_name" : "Cell type",
  "pro_name" : "Process type"
}, {
  "prm_val_unf" : "Unified Parameter value",
  "reg_con_unt" : "Regulator concentration unit",
  "prm_unt" : "Parameter unit",
  "dsp_type" : "Dispersion type",
  "exp_res" : "Experiment result type",
  "exp_val" : "Experimental value",
  "c_line" : "Cell line/primary cells",
  "ser_stmln" : "Stimulation",
  "r_name" : "Regulator",
  "r_name_db" : "Regulator DB name",
  "m_mw" : "Modifier Mw(kDa)",
  "prd_name" : "Cell product",
  "exp_u" : "Experiment time unit",
  "d_name" : "Patient’s state",
  "dt_name" : "Daughter cells",
  "exp_t" : "Experiment time",
  "t_name" : "Source of cells",
  "exp_val_unt" : "Experimental value unit",
  "ser_age" : "Age category",
  "mod_con" : "Modifier concentration",
  "reg_con" : "Regulator concentration",
  "prm_val" : "Parameter value",
  "avg_type" : "Average type",
  "r_mw" : "Regulator Mw(kDa)",
  "cell_con_unt" : "Initial cell concentration unit",
  "ser_comment" : "Commentary",
  "prd_name_db" : "Cell product DB name",
  "prm_name" : "Parameter",
  "ser_cm" : "Culture media",
  "n_val" : "N of in vitro experiments",
  "dsp_left" : "Dispersion left",
  "pmid" : "Article PMID",
  "dsp_right" : "Dispersion right",
  "mod_con_unt" : "Modifier concentration unit",
  "prd_mw" : "Product Mw(kDa)",
  "m_name" : "Modifier",
  "m_name_db" : "Modifier DB name",
  "ser_phc" : "Cell phenotype",
  "stm_cell" : "Stimulated cells",
  "cell_con" : "Initial cell concentration",
  "c_name" : "Cell type",
  "pro_name" : "Process type"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

successful operation

400

Invalid status value. This response appears when the required object does not exist in the DB.

QueryDataHeaders

Up 
get /query_data_headers
Return the list with query headers, where multiple inputs can be selected for all parameters, but currently, only the "OR" logic is supported. (queryDataHeadersGet)

Return type

array[QueryDataHeader]

Example data

Content-Type: application/json
[ {
  "ColumnDesc" : "ColumnDesc",
  "ColumnVariable" : "ColumnVariable"
}, {
  "ColumnDesc" : "ColumnDesc",
  "ColumnVariable" : "ColumnVariable"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

successful operation

400

Invalid status value. This response appears when the required object does not exist in the DB.

Regulators

Up 
get /regulators
Return the list of regulatory molecules (activators or inhibitors which influence on cell processes) to be used in Query (optional parameter for query). (regulatorsGet)

Return type

array[Regulator]

Example data

Content-Type: application/json
[ {
  "name" : "TNF",
  "id" : 10
}, {
  "name" : "TNF",
  "id" : 10
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

successful operation

400

Invalid status value. This response appears when the required object does not exist in the DB.

Stimulated

Up 
get /stimulated
Return the list of cell stimulation conditions (yes/no/no matter). Optional parameter for weighted statistics calculation. If user does not choose option "Calculate weighted statistics" parameter "stimulated" is not used. (stimulatedGet)

Return type

array[Stimulated]

Example data

Content-Type: application/json
[ {
  "name" : "false",
  "id" : 10
}, {
  "name" : "false",
  "id" : 10
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

successful operation

400

Invalid status value. This response appears when the required object does not exist in the DB.

Models

[ Jump to Methods ]

Table of Contents

  1. DaughterCell -
  2. Modifier -
  3. Parameter -
  4. PatientState -
  5. ProcessType -
  6. Product -
  7. QueryData -
  8. QueryDataHeader -
  9. Regulator -
  10. Stimulated -

DaughterCell - Up

id
Long format: int64
name
String Daughter cell name used

Modifier - Up

id
Long format: int64
name
String Modifier name used

Parameter - Up

id
Long format: int64
name
String Parameter name available

PatientState - Up

id
Long format: int64
name
String Patient state available

ProcessType - Up

id
Long format: int64
name
String Process type name available

Product - Up

id
Long format: int64
name
String Product

QueryData - Up

prm_name (optional)
String Parameter
prm_val_unf (optional)
String Unified Parameter value
prm_val (optional)
String Parameter value
prm_unt (optional)
String Parameter unit
pro_name (optional)
String Process type
stm_cell (optional)
String Stimulated cells
c_name (optional)
String Cell type
prd_name (optional)
String Cell product
prd_name_db (optional)
String Cell product DB name
prd_mw (optional)
String Product Mw(kDa)
dt_name (optional)
String Daughter cells
n_val (optional)
String N of in vitro experiments
avg_type (optional)
String Average type
exp_val (optional)
String Experimental value
dsp_type (optional)
String Dispersion type
dsp_left (optional)
String Dispersion left
dsp_right (optional)
String Dispersion right
exp_val_unt (optional)
String Experimental value unit
exp_res (optional)
String Experiment result type
r_name (optional)
String Regulator
r_name_db (optional)
String Regulator DB name
r_mw (optional)
String Regulator Mw(kDa)
reg_con (optional)
String Regulator concentration
reg_con_unt (optional)
String Regulator concentration unit
m_name (optional)
String Modifier
m_name_db (optional)
String Modifier DB name
m_mw (optional)
String Modifier Mw(kDa)
mod_con (optional)
String Modifier concentration
mod_con_unt (optional)
String Modifier concentration unit
exp_t (optional)
String Experiment time
exp_u (optional)
String Experiment time unit
cell_con (optional)
String Initial cell concentration
cell_con_unt (optional)
String Initial cell concentration unit
t_name (optional)
String Source of cells
c_line (optional)
String Cell line/primary cells
ser_phc (optional)
String Cell phenotype
ser_cm (optional)
String Culture media
ser_stmln (optional)
String Stimulation
ser_comment (optional)
String Commentary
d_name (optional)
String Patient’s state
ser_age (optional)
String Age category
pmid (optional)
String Article PMID

QueryDataHeader - Up

ColumnVariable (optional)
String column variable name
ColumnDesc (optional)
String column description

Regulator - Up

id
Long format: int64
name
String Regulator name used

Stimulated - Up

id
Long format: int64
name
String Stimulated name available