APIs metadata, documentation and preview (only available if no parameters are required ).
Test
schema_name | function_name | table_name | parameter_name | parameter_description | parameter_mode_io | parameter_type_io | parameter_def_value | parameter_compulsory | ordinal_position |
---|---|---|---|---|---|---|---|---|---|
dopa | api_dopa_species() | api_dopa_species_template | a_id_no | None | IN | bigint | NULL::bigint | None | 1 |
dopa | api_dopa_species() | api_dopa_species_template | binomial | None | OUT | text | None | None | 7 |
dopa | api_dopa_species() | api_dopa_species_template | category | None | OUT | text | None | None | 8 |
dopa | api_dopa_species() | api_dopa_species_template | class | None | OUT | text | None | None | 3 |
dopa | api_dopa_species() | api_dopa_species_template | conservation_needed_code | None | OUT | text | None | None | 23 |
dopa | api_dopa_species() | api_dopa_species_template | conservation_needed_name | None | OUT | text | None | None | 24 |
dopa | api_dopa_species() | api_dopa_species_template | country_code | None | OUT | text | None | None | 15 |
dopa | api_dopa_species() | api_dopa_species_template | country_n | None | OUT | integer | None | None | 10 |
dopa | api_dopa_species() | api_dopa_species_template | country_name | None | OUT | text | None | None | 16 |
dopa | api_dopa_species() | api_dopa_species_template | ecosystems | None | OUT | text | None | None | 12 |
dopa | api_dopa_species() | api_dopa_species_template | endemic | None | OUT | boolean | None | None | 11 |
dopa | api_dopa_species() | api_dopa_species_template | family | None | OUT | text | None | None | 5 |
dopa | api_dopa_species() | api_dopa_species_template | genus | None | OUT | text | None | None | 6 |
dopa | api_dopa_species() | api_dopa_species_template | habitat_code | None | OUT | text | None | None | 13 |
dopa | api_dopa_species() | api_dopa_species_template | habitat_name | None | OUT | text | None | None | 14 |
dopa | api_dopa_species() | api_dopa_species_template | id_no | None | OUT | bigint | None | None | 2 |
dopa | api_dopa_species() | api_dopa_species_template | order_ | None | OUT | text | None | None | 4 |
dopa | api_dopa_species() | api_dopa_species_template | research_needed_code | None | OUT | text | None | None | 21 |
dopa | api_dopa_species() | api_dopa_species_template | research_needed_name | None | OUT | text | None | None | 22 |
dopa | api_dopa_species() | api_dopa_species_template | stress_code | None | OUT | text | None | None | 17 |
dopa | api_dopa_species() | api_dopa_species_template | stress_name | None | OUT | text | None | None | 18 |
dopa | api_dopa_species() | api_dopa_species_template | threat_code | None | OUT | text | None | None | 19 |
dopa | api_dopa_species() | api_dopa_species_template | threat_name | None | OUT | text | None | None | 20 |
dopa | api_dopa_species() | api_dopa_species_template | threatened | None | OUT | boolean | None | None | 9 |
dopa | api_dopa_species() | api_dopa_species_template | usetrade_code | None | OUT | integer | None | None | 25 |
dopa | api_dopa_species() | api_dopa_species_template | usetrade_name | None | OUT | text | None | None | 26 |
dopa | api_dopa_species_list() | api_dopa_species_list_template | a_id_no | None | IN | bigint | NULL::bigint | None | 1 |
dopa | api_dopa_species_list() | api_dopa_species_list_template | b_class | None | IN | text | NULL::text | None | 2 |
dopa | api_dopa_species_list() | api_dopa_species_list_template | c_order | None | IN | text | NULL::text | None | 3 |
dopa | api_dopa_species_list() | api_dopa_species_list_template | d_family | None | IN | text | NULL::text | None | 4 |
dopa | api_dopa_species_list() | api_dopa_species_list_template | e_genus | None | IN | text | NULL::text | None | 5 |
dopa | api_dopa_species_list() | api_dopa_species_list_template | f_binomial | None | IN | text | NULL::text | None | 6 |
dopa | api_dopa_species_list() | api_dopa_species_list_template | g_category | None | IN | text | NULL::text | None | 7 |
dopa | api_dopa_species_list() | api_dopa_species_list_template | h_threatened | None | IN | boolean | NULL::boolean | None | 8 |
dopa | api_dopa_species_list() | api_dopa_species_list_template | i_ecosystems | None | IN | text | NULL::text | None | 9 |
dopa | api_dopa_species_list() | api_dopa_species_list_template | j_habitats | None | IN | text | NULL::text | None | 10 |
dopa | api_dopa_species_list() | api_dopa_species_list_template | k_country | None | IN | text | NULL::text | None | 11 |
dopa | api_dopa_species_list() | api_dopa_species_list_template | l_endemic | None | IN | boolean | NULL::boolean | None | 12 |
dopa | api_dopa_species_list() | api_dopa_species_list_template | m_stresses | None | IN | text | NULL::text | None | 13 |
dopa | api_dopa_species_list() | api_dopa_species_list_template | n_threats | None | IN | text | NULL::text | None | 14 |
dopa | api_dopa_species_list() | api_dopa_species_list_template | o_research_needed | None | IN | text | NULL::text | None | 15 |
dopa | api_dopa_species_list() | api_dopa_species_list_template | p_conservation_needed | None | IN | text | NULL::text | None | 16 |
dopa | api_dopa_species_list() | api_dopa_species_list_template | q_usetrade | None | IN | text | NULL::text | None | 17 |
dopa | api_dopa_species_list_category() | api_dopa_species_list_category_template | None | None | None | None | None | None | None |
dopa | api_dopa_species_list_category_alt() | api_dopa_species_list_category_alt_template | threatened | None | IN | boolean | NULL::boolean | None | 1 |
dopa | api_dopa_species_list_conservation_needed() | api_dopa_species_list_conservation_needed_template | None | None | None | None | None | None | None |
dopa | api_dopa_species_list_country() | api_dopa_species_list_country_template | None | None | None | None | None | None | None |
dopa | api_dopa_species_list_habitat() | api_dopa_species_list_habitat_template | None | None | None | None | None | None | None |
dopa | api_dopa_species_list_research_needed() | api_dopa_species_list_research_needed_template | None | None | None | None | None | None | None |
dopa | api_dopa_species_list_stress() | api_dopa_species_list_stress_template | None | None | None | None | None | None | None |
Column name | Comment |
---|---|
schema_name | None |
function_name | None |
table_name | None |
parameter_name | None |
parameter_description | None |
parameter_mode_io | None |
parameter_type_io | None |
parameter_def_value | None |
parameter_compulsory | None |
ordinal_position | None |
Filter returned fields in the url query using field names separated by comma, eg:
https://api.biopama.org/api/dopa/view/api_functions_parameters?fields=field_name1,field_name2,...
Limit returned records in the url query using the limit parameter, eg:
https://api.biopama.org/api/dopa/view/api_functions_parameters?limit=100
or remove the limit argument to display all of them (might take some time for large datasets).
By default limit is set to 50 records.