Obter dados - GET

Como obter dados usando a GET API!

Parâmetros GET compartilhados

Endpoints GET

/ (GET)

Testa seu acesso/token.

Nenhum parâmetro para este endpoint.


bibreferences (GET)

Referências bibliográficas (GET lista, POST cria).

ParâmetroObrigatórioDescriçãoExemplo
idNãoId unico ou lista separada por virgula para filtrar/selecionar registros.1,2,3
bibkeyNãoBibkey ou lista de bibkeys.ducke1953,mayr1992
biocollectionNãoId/nome/sigla de biocoleção; retorna referências que citam vouchers dessas coleções.INPA
datasetNãoId ou nome de dataset; retorna referências ligadas ao dataset.Forest1
fieldsNãoLista separada por vírgulas dos campos a serem incluídos na resposta ou uma palavra especial all/simple/raw, padrão: simpleid,scientificName ou all
job_idNãoId do job para reutilizar affected_ids ou filtrar resultados.1024
limitNãoQuantidade maxima de registros retornados.100
offsetNãoA posição inicial do conjunto de registros a ser exportado. Usado em conjunto com limit para limitar os resultados.10000
save_jobNãoSe 1, salva a consulta como job para baixar depois via userjobs + get_file = 11
searchNãoBusca full-text no bibtex em modo booleano; espaços funcionam como AND.Amazon forest
taxonNãoLista de ids ou nomes canônicos de taxon; retorna referências ligadas ao taxon.Ocotea guianensis,Minquartia guianensis ou 120,455
taxon_rootNãoId/nome de taxon incluindo descendentes.Lauraceae

Campos retornados

Campos (simple): id, bibkey, year, author, title, doi, url, bibtex

Campos (all): id, bibkey, year, author, title, doi, url, bibtex

Exemplo de resposta

{
    "meta": {
        "odb_version": "0.10.0-alpha1",
        "api_version": "v0",
        "server": "http://localhost/opendatabio"
    },
    "data": [
        {
            "id": 2,
            "bibkey": "Riberiroetal1999FloraDucke",
            "year": 1999,
            "author": "José Eduardo Lahoz Da Silva Ribeiro and Michael John Gilbert Hopkins and Alberto Vicentini and Cynthia Anne Sothers and Maria Auxiliadora Da Silva Costa and Joneide Mouzinho De Brito and Maria Anália Duarte De Souza and Lúcia Helena Pinheiro Martins and Lúcia Garcez Lohmann and Paulo Apóstolo Costa Lima Assunção and Everaldo Da Costa Pereira and Cosme Fernandes Da Silva and Mariana Rabello Mesquita and Lilian Costa Procópio",
            "title": "Flora Da Reserva Ducke: Guia De Identificação Das Plantas Vasculares De Uma Floresta De Terra Firme Na Amazônica Central",
            "doi": null,
            "url": null,
            "bibtex": "@Article{Riberiroetal1999FloraDucke,\r\n  title = {Flora da Reserva Ducke: Guia de Identifica{\\c{c}}{\\~a}o das Plantas Vasculares de uma Floresta de Terra Firme na Amaz{\\^o}nica Central},\r\n  author = {José Eduardo Lahoz da Silva Ribeiro and Michael John Gilbert Hopkins and Alberto Vicentini and Cynthia Anne Sothers and Maria Auxiliadora da Silva Costa and Joneide Mouzinho de Brito and Maria Anália Duarte de Souza and Lúcia Helena Pinheiro Martins and Lúcia Garcez Lohmann and Paulo Apóstolo Costa Lima Assunç{ã}o and Everaldo da Costa Pereira and Cosme Fernandes da Silva and Mariana Rabello Mesquita and Lilian Costa Procópio},\r\n  journal = {Flora da Reserva Ducke: Guia de Identifica{\\c{c}}{\\~a}o das Plantas Vasculares de uma Floresta de Terra Firme na Amaz{\\^o}nica Central},\r\n  year = {1999},\r\n  publisher = {INPA-DFID Manaus},\r\n  pages = {819p},\r\n}"
        },
        {
            "id": 3,
            "bibkey": "Sutter2006female",
            "year": 2006,
            "author": "D. Merino Sutter and P. I. Forster and P. K. Endress",
            "title": "Female Flowers And Systematic Position Of Picrodendraceae (Euphorbiaceae S.l., Malpighiales)",
            "doi": "10.1007/s00606-006-0414-0",
            "url": "http://dx.doi.org/10.1007/s00606-006-0414-0",
            "bibtex": "@article{Sutter2006female,\n     author = {D. Merino Sutter and P. I. Forster and P. K. Endress},\n     year = {2006},\n     title = {Female flowers and systematic position of Picrodendraceae (Euphorbiaceae s.l., Malpighiales)},\n     issn = {0378-2697 | 1615-6110},\n     issue = {1-4},\n     url = {http://dx.doi.org/10.1007/s00606-006-0414-0},\n     doi = {10.1007/s00606-006-0414-0},\n     volume = {261},\n     page = {187-215},\n     journal = {Plant Systematics and Evolution},\n     journal_short = {Plant Syst. Evol.},\n     published = {Springer Science and Business Media LLC}\n}"
        }
    ]
}

biocollections (GET)

Biocoleções (GET lista, POST cria).

ParâmetroObrigatórioDescriçãoExemplo
idNãoId unico ou lista separada por virgula para filtrar/selecionar registros.1,2,3
acronymNãoSigla da biocoleção.INPA
fieldsNãoLista separada por vírgulas dos campos a serem incluídos na resposta ou uma palavra especial all/simple/raw, padrão: simpleid,scientificName ou all
irnNãoIRN do Index Herbariorum para filtrar biocoleções.123456
job_idNãoId do job para reutilizar affected_ids ou filtrar resultados.1024
limitNãoQuantidade maxima de registros retornados.100
nameNãoNome exato da biocoleção (string simples).Herbário do INPA
offsetNãoA posição inicial do conjunto de registros a ser exportado. Usado em conjunto com limit para limitar os resultados.10000
save_jobNãoSe 1, salva a consulta como job para baixar depois via userjobs + get_file = 11
searchNãoParametro de busca de texto.Silva

Campos retornados

Campos (simple): id, acronym, name, irn

Campos (all): id, acronym, name, irn, country, city, address

Exemplo de resposta

{
    "meta": {
        "odb_version": "0.10.0-alpha1",
        "api_version": "v0",
        "server": "http://localhost/opendatabio"
    },
    "data": [
        {
            "id": 1,
            "acronym": "INPA",
            "name": "Instituto Nacional de Pesquisas da Amazônia",
            "irn": 124921,
            "country": null,
            "city": null,
            "address": null
        },
        {
            "id": 2,
            "acronym": "SPB",
            "name": "Universidade de São Paulo",
            "irn": 126324,
            "country": null,
            "city": null,
            "address": null
        }
    ]
}

datasets (GET)

Datasets e arquivos de versões publicadas (GET lista, POST cria via job de importação).

ParâmetroObrigatórioDescriçãoExemplo
idNãoId unico ou lista separada por virgula para filtrar/selecionar registros.1,2,3
bibreferenceNãoId ou bibkey da referência.34
fieldsNãoLista separada por vírgulas dos campos a serem incluídos na resposta ou uma palavra especial all/simple/raw, padrão: simpleid,scientificName ou all
file_nameNãoNome do arquivo de versão de dataset para download.2_Organisms.csv
has_versionsNãoQuando 1, retorna apenas datasets que possuem versões publicas.1
include_urlNãoQuando 1 com list_versions, inclui URL para download do arquivo.1
limitNãoQuantidade maxima de registros retornados.100
list_versionsNãoSe 1, lista arquivos de versões de dataset para os ids informados.1
nameNãoParametro generico de nome (taxon completo, local, export_name de trait, etc.).Ocotea guianensis
offsetNãoA posição inicial do conjunto de registros a ser exportado. Usado em conjunto com limit para limitar os resultados.10000
projectNãoId ou sigla do projeto.PDBFF ou 2
save_jobNãoSe 1, salva a consulta como job para baixar depois via userjobs + get_file = 11
searchNãoParametro de busca de texto.Silva
summarizeNãoId do dataset para retornar sumarios de conteudo/taxonomia/traits.3
tagNãoTag/número/código do indivíduo.A-1234
tagged_withNãoIds de tags (virgula) ou texto para filtrar datasets por tags (lista de ids ou full-text).12,13 ou copa folha
taxonNãoId ou nome canônico do taxon (lista aceita).Licaria cannela,Licaria armeniaca ou 456,789
taxon_rootNãoId/nome de taxon incluindo descendentes.Lauraceae
traitsNãoLista de ids de traits (separados por virgula) para filtrar datasets.12,15

Campos retornados

Campos (simple): id, name, title, projectName, description, notes, contactEmail, taggedWidth, uuid

Campos (all): id, name, title, projectName, notes, privacyLevel, policy, description, measurements_count, contactEmail, taggedWidth, uuid

Exemplo de resposta

{
    "meta": {
        "odb_version": "0.10.0-alpha1",
        "api_version": "v0",
        "server": "http://localhost/opendatabio"
    },
    "data": [
        {
            "id": 4,
            "name": "PDBFF-FITO 1ha core plots 1-10cm dbh - TREELETS",
            "title": "Arvoretas (1cm>DAP",
            "projectName": "Projeto Dinâmica Biológica de Fragmentos Florestais (PDBFF-Data)",
            "notes": null,
            "privacyLevel": "Restrito a usuários autorizados",
            "policy": null,
            "description": "Contém o único censo de árvores de pequeno porte 1-10cm de diâmetro nas parcelas de 1ha do PDBFF, em 11 das 69 de parcelas permanentes de 1ha do Programa de Monitoramento de Plantas do PDBFF.",
            "measurements_count": null,
            "contactEmail": "example",
            "taggedWidth": "Parcelas florestais | PDBFF | Fitodemográfico",
            "uuid": "e1d8ce8d-4847-11f0-8e9f-9cb654b86224"
        }
    ]
}

individuals (GET)

Indivíduos (GET lista, POST cria, PUT atualiza).

ParâmetroObrigatórioDescriçãoExemplo
idNãoId unico ou lista separada por virgula para filtrar/selecionar registros.1,2,3
datasetNãoId/nome de dataset; com trait filtra por dataset_id de medições existentes, senão o dataset_id do indivíduo.3 ou FOREST1
date_maxNãoData final inclusiva (AAAA-MM-DD) comparada com a data do indivíduo.2024-12-31
date_minNãoData inicial inclusiva (AAAA-MM-DD) comparada com a data do indivíduo.2020-01-01
fieldsNãoLista separada por vírgulas dos campos a serem incluídos na resposta ou uma palavra especial all/simple/raw, padrão: simpleid,scientificName ou all
job_idNãoId do job para reutilizar affected_ids ou filtrar resultados.1024
limitNãoQuantidade maxima de registros retornados.100
locationNãoLista de ids/nomes de locais; retorna indivíduos ligados à esses locais.Parcela 25ha ou 55,60
location_rootNãoId/nome de local; inclui descendentes dos locais informados; retorna individuos dentro dos locais informadosAmazonas
odbrequest_idNãoId de request para filtrar indivíduos vinculados a esse pedido ODB.12
offsetNãoA posição inicial do conjunto de registros a ser exportado. Usado em conjunto com limit para limitar os resultados.10000
personNãoIds/nomes/abreviação/emails de coletoresSilva, J.B. da, Assunção, P.C.L. ou Paulo Apóstolo Costa Lima Assunção ou 3,567,300
projectNãoId/nome de projeto; filtra indivíduos cujo dataset pertence ao projeto.PDBFF
save_jobNãoSe 1, salva a consulta como job para baixar depois via userjobs + get_file = 11
tagNãoFiltro por tag/número de indivíduo; aceita lista separada por virgula.A-123,2001,24,54
taxonNãoLista de ids/nomes de taxon; filtra pela identificacao exata (sem descendentes).Licaria cannela ou 456
taxon_rootNãoLista de ids/nomes de taxon; inclui descendentes de cada taxon.Lauraceae
traitNãoIds/export_name de traits; retorna indivíduos que tem medições para esses traits12,15 ou treeDbh,treeDbhPom
vernacularNãoIds/nomes de vernáculos (nomes populares) vinculados à indivíduos.castanha,itaúba,jacareúba ou 24,56,74

Campos retornados

Campos (simple): id, basisOfRecord, organismID, recordedByMain, recordNumber, recordedDate, family, scientificName, identificationQualifier, identifiedBy, dateIdentified, locationName, locationParentName, decimalLatitude, decimalLongitude, x, y, gx, gy, angle, distance, datasetName

Campos (all): id, basisOfRecord, organismID, recordedByMain, recordNumber, recordedDate, recordedBy, scientificName, scientificNameAuthorship, taxonPublishedStatus, genus, family, identificationQualifier, identifiedBy, dateIdentified, identificationRemarks, identificationBiocollection, identificationBiocollectionReference, locationName, higherGeography, decimalLatitude, decimalLongitude, georeferenceRemarks, locationParentName, x, y, gx, gy, angle, distance, organismRemarks, datasetName, uuid

Exemplo de resposta

{
    "meta": {
        "odb_version": "0.10.0-alpha1",
        "api_version": "v0",
        "server": "http://localhost/opendatabio"
    },
    "data": [
        {
            "id": 306246,
            "basisOfRecord": "Organism",
            "organismID": "2639_Spruce_1852",
            "recordedByMain": "Spruce, R.",
            "recordNumber": "2639",
            "recordedDate": "1852-10",
            "recordedBy": "Spruce, R.",
            "scientificName": "Ecclinusa lanceolata",
            "scientificNameAuthorship": "(Mart. & Eichler) Pierre",
            "taxonPublishedStatus": "published",
            "genus": "Ecclinusa",
            "family": "Sapotaceae",
            "identificationQualifier": "",
            "identifiedBy": "Spruce, R.",
            "dateIdentified": "1852-10-00",
            "identificationRemarks": "",
            "identificationBiocollection": null,
            "identificationBiocollectionReference": null,
            "locationName": "São Gabriel da Cachoeira",
            "higherGeography": "São Gabriel da Cachoeira < Amazonas < Brasil",
            "decimalLatitude": 1.1841927,
            "decimalLongitude": -66.80167715,
            "georeferenceRemarks": "decimal coordinates are the CENTROID of the footprintWKT geometry",
            "locationParentName": "Amazonas",
            "x": null,
            "y": null,
            "gx": null,
            "gy": null,
            "angle": null,
            "distance": null,
            "organismRemarks": "prope Panure ad Rio Vaupes Amazonas, Brazil",
            "datasetName": "Exsicatas LABOTAM",
            "uuid": "c01000f0-f437-11ef-b90b-9cb654b86224"
        }
    ]
}

individual-locations (GET)

Ocorrências para indivíduos com múltiplas localizações (GET lista, POST/PUT grava).

ParâmetroObrigatórioDescriçãoExemplo
idNãoId unico ou lista separada por virgula para filtrar/selecionar registros.1,2,3
datasetNãoId/nome de dataset; filtra pelo dataset do indivíduo vinculado.FOREST1
date_maxNãoData/hora maxima; compara date_time ou data do indivíduo quando vazio.2024-12-31
date_minNãoData/hora minima; compara date_time ou data do indivíduo quando vazio.2020-01-01
fieldsNãoLista separada por vírgulas dos campos a serem incluídos na resposta ou uma palavra especial all/simple/raw, padrão: simpleid,scientificName ou all
individualNãoLista de ids de indivíduos com ocorrências retornadas.12,44
limitNãoQuantidade maxima de registros retornados.100
locationNãoId ou nome do local.Parcela 25ha ou 55
location_rootNãoId/nome do local incluindo descendentes.Amazonas ou 10
offsetNãoA posição inicial do conjunto de registros a ser exportado. Usado em conjunto com limit para limitar os resultados.10000
personNãoIds/nomes/emails de coletores; filtra pelas coletas dos indivíduos.Silva, J.B.|23
projectNãoId/nome de projeto; filtra ocorrências de indivíduos em datasets do projeto.PDBFF
save_jobNãoSe 1, salva a consulta como job para baixar depois via userjobs + get_file = 11
tagNãoLista de tags/números de indivíduo; compara com individuals.number.A-123,B-2
taxonNãoId ou nome canônico do taxon (lista aceita).Licaria cannela,Licaria armeniaca ou 456,789
taxon_rootNãoId/nome de taxon incluindo descendentes.Lauraceae

Campos retornados

Campos (simple): id, individual_id, basisOfRecord, occurrenceID, organismID, recordedDate, locationName, higherGeography, decimalLatitude, decimalLongitude, x, y, angle, distance, minimumElevation, occurrenceRemarks, scientificName, family, datasetName

Campos (all): id, individual_id, basisOfRecord, occurrenceID, organismID, scientificName, family, recordedDate, locationName, higherGeography, decimalLatitude, decimalLongitude, georeferenceRemarks, x, y, angle, distance, minimumElevation, occurrenceRemarks, organismRemarks, datasetName

Exemplo de resposta

{
    "meta": {
        "odb_version": "0.10.0-alpha1",
        "api_version": "v0",
        "server": "http://localhost/opendatabio"
    },
    "data": [
        {
            "id": 306244,
            "individual_id": 306246,
            "basisOfRecord": "Occurrence",
            "occurrenceID": "2639_Spruce_1852.1852-10",
            "organismID": "2639_Spruce_1852",
            "scientificName": "Ecclinusa lanceolata",
            "family": "Sapotaceae",
            "recordedDate": "1852-10",
            "locationName": "São Gabriel da Cachoeira",
            "higherGeography": "Brasil > Amazonas > São Gabriel da Cachoeira",
            "decimalLatitude": 1.1841927,
            "decimalLongitude": -66.80167715,
            "georeferenceRemarks": "decimal coordinates are the CENTROID of the footprintWKT geometry",
            "x": null,
            "y": null,
            "angle": null,
            "distance": null,
            "minimumElevation": null,
            "occurrenceRemarks": null,
            "organismRemarks": "prope Panure ad Rio Vaupes Amazonas, Brazil",
            "datasetName": "Exsicatas LABOTAM"
        }
    ]
}

languages (GET)

Lista idiomas disponíveis.

ParâmetroObrigatórioDescriçãoExemplo
fieldsNãoLista separada por vírgulas dos campos a serem incluídos na resposta ou uma palavra especial all/simple/raw, padrão: simpleid,scientificName ou all
limitNãoQuantidade maxima de registros retornados.100
offsetNãoA posição inicial do conjunto de registros a ser exportado. Usado em conjunto com limit para limitar os resultados.10000

Exemplo de resposta

{
    "meta": {
        "odb_version": "0.10.0-alpha1",
        "api_version": "v0",
        "server": "http://localhost/opendatabio"
    },
    "data": [
        {
            "id": 1,
            "code": "en",
            "name": "English",
            "is_locale": 1,
            "created_at": null,
            "updated_at": null
        }
    ]
}

locations (GET)

Localidades (GET lista, POST cria, PUT atualiza).

ParâmetroObrigatórioDescriçãoExemplo
idNãoId unico ou lista separada por virgula para filtrar/selecionar registros.1,2,3
adm_levelNãoUm ou mais códigos adm_level (separados por virgula ou array).10,100
datasetNãoId/nome de dataset; expande para todas as locations usadas pelo dataset.FOREST1
fieldsNãoLista separada por vírgulas dos campos a serem incluídos na resposta ou uma palavra especial all/simple/raw, padrão: simpleid,scientificName ou all
job_idNãoId do job para reutilizar affected_ids ou filtrar resultados.1024
latNãoLatitude (graus decimais) usada com querytype.-3.11
limitNãoQuantidade maxima de registros retornados.100
location_rootNãoAlias de root para compatibilidade.Amazonas
longNãoLongitude (graus decimais) usada com querytype.-60.02
nameNãoCorrespondencia exata de nome; aceita lista de nomes ou ids.Manaus
offsetNãoA posição inicial do conjunto de registros a ser exportado. Usado em conjunto com limit para limitar os resultados.10000
parent_idNãoId do pai para consultas hierarquicas.210
projectNãoId ou sigla do projeto.PDBFF ou 2
querytypeNãoQuando lat/long informados: busca geometrica exact|parent|closest.parent
rootNãoId/nome de local; retorna ele e todos os descendentes/relacionados.Amazonas
save_jobNãoSe 1, salva a consulta como job para baixar depois via userjobs + get_file = 11
searchNãoBusca prefixada no nome (SQL LIKE name%).Mana
taxonNãoLista de ids/nomes de taxon; filtra locations por identificações vinculadas.Euterpe edulis
taxon_rootNãoLista de ids/nomes de taxon; inclui descendentes ao filtrar identificações vinculadas.Lauraceae
traitNãoId/nome de trait; so funciona junto com dataset para filtrar por measurements.DBH

Campos retornados

Campos (simple): id, basisOfRecord, locationName, adm_level, country_adm_level, x, y, startx, starty, distance_to_search, parent_id, parentName, higherGeography, footprintWKT, locationRemarks, decimalLatitude, decimalLongitude, georeferenceRemarks, geodeticDatum

Campos (all): id, basisOfRecord, locationName, adm_level, country_adm_level, x, y, startx, starty, distance_to_search, parent_id, parentName, higherGeography, footprintWKT, locationRemarks, decimalLatitude, decimalLongitude, georeferenceRemarks, geodeticDatum

Exemplo de resposta

{
    "meta": {
        "odb_version": "0.10.0-alpha1",
        "api_version": "v0",
        "server": "http://localhost/opendatabio"
    },
    "data": [
        {
            "id": 27297,
            "basisOfRecord": "Location",
            "locationName": "Parcela 1105",
            "adm_level": 100,
            "country_adm_level": "Parcela",
            "x": "100.00",
            "y": "100.00",
            "startx": null,
            "starty": null,
            "distance_to_search": null,
            "parent_id": 27277,
            "parentName": "Fazenda Esteio",
            "higherGeography": "Brasil > Amazonas > Rio Preto da Eva > Fazenda Esteio > Parcela 1105",
            "footprintWKT": "POLYGON((-59.81371985 -2.42215752,-59.81360263 -2.42126619,-59.81270751 -2.42136656,-59.81282469 -2.42225788,-59.81371985 -2.42215752))",
            "locationRemarks": "source: Polígono desenhado a partir das coordenadas de GPS dos vértices; georeferencedBy: Diogo Martins Rosa & Ana Andrade; fundedBy: Edital CNPq-Brasil/LBA 458027/2013-8; geometryBy: Alberto Vicentini; geometryDate: 2021-09-29; warning: Conflito com polígono da UC de 2021. Este polígono deveria ter a mesma geometria do polígono correspondente que faz parte da UC ARIE PDBFF, mas como ele foi gerado pelas coordenadas de campo, foi mantida essa geometria. A UC, portanto, não protege adequadamente essa parcela de monitoramento.",
            "decimalLatitude": -2.42215752,
            "decimalLongitude": -59.81371985,
            "georeferenceRemarks": "decimal coordinates are the START POINT in footprintWKT geometry",
            "geodeticDatum": null
        }
    ]
}

measurements (GET)

Medições de traits (GET lista, POST cria via job de importação, PUT atualiza).

ParâmetroObrigatórioDescriçãoExemplo
idNãoId unico ou lista separada por virgula para filtrar/selecionar registros.1,2,3
bibreferenceNãoId ou bibkey da referência.34
datasetNãoId ou sigla do dataset.3 ou FOREST1
date_maxNãoFiltra registros ate esta data (AAAA-MM-DD).2024-12-31
date_minNãoFiltra registros a partir desta data (AAAA-MM-DD).2020-01-01
fieldsNãoLista separada por vírgulas dos campos a serem incluídos na resposta ou uma palavra especial all/simple/raw, padrão: simpleid,scientificName ou all
individualNãoId, uuid ou organismID do indivíduo.4521 ou 2ff0e884-3d33
job_idNãoId do job para reutilizar affected_ids ou filtrar resultados.1024
limitNãoQuantidade maxima de registros retornados.100
locationNãoId ou nome do local.Parcela 25ha ou 55
location_rootNãoId/nome do local incluindo descendentes.Amazonas ou 10
measured_idNãoFiltro de measurement: id do objeto medido (coerente com measured_type).4521
measured_typeNãoFiltro de measurement: classe do objeto medido (Individual, Location, Taxon, Voucher, Media).Media
offsetNãoA posição inicial do conjunto de registros a ser exportado. Usado em conjunto com limit para limitar os resultados.10000
personNãoId/abreviação/nome/email de pessoa (aceita lista com | ou ;).Silva, J.B.|Costa, M.
projectNãoId ou sigla do projeto.PDBFF ou 2
save_jobNãoSe 1, salva a consulta como job para baixar depois via userjobs + get_file = 11
taxonNãoId ou nome canônico do taxon (lista aceita).Licaria cannela,Licaria armeniaca ou 456,789
taxon_rootNãoId/nome de taxon incluindo descendentes.Lauraceae
traitNãoId ou export_name do trait para filtro.DBH
trait_typeNãoFiltra measurements pelo código do tipo de trait.1
voucherNãoId do voucher para filtrar measurements.102

Campos retornados

Campos (simple): id, basisOfRecord, measured_type, measured_id, measurementType, measurementValue, measurementUnit, measurementDeterminedBy, measurementDeterminedDate, scientificName, datasetName, family, sourceCitation

Campos (all): id, basisOfRecord, measured_type, measured_id, measurementType, measurementValue, measurementUnit, measurementDeterminedDate, measurementDeterminedBy, measurementRemarks, resourceRelationship, resourceRelationshipID, relationshipOfResource, scientificName, family, datasetName, measurementMethod, sourceCitation, measurementLocationId, measurementParentId, decimalLatitude, decimalLongitude

Exemplo de resposta

{
    "meta": {
        "odb_version": "0.10.0-alpha1",
        "api_version": "v0",
        "server": "http://localhost/opendatabio"
    },
    "data": [
        {
            "id": 1,
            "basisOfRecord": "MeasurementsOrFact",
            "measured_type": "App\\Models\\Individual",
            "measured_id": 86947,
            "measurementType": "treeDbh",
            "measurementValue": 13,
            "measurementUnit": "cm",
            "measurementDeterminedDate": "1979-11-14",
            "measurementDeterminedBy": "Menezes, J.F. | Bahia, R.P. | Lima, J. | Santos, R.M. | Ferreira, A.J.C. | Cardoso, Romeu M.",
            "measurementRemarks": null,
            "resourceRelationship": null,
            "resourceRelationshipID": "1202-1371_Menezes_1979",
            "relationshipOfResource": "measurement of",
            "scientificName": "Paramachaerium ormosioides",
            "family": "Fabaceae",
            "datasetName": "Censos 01 - PDBFF-FITO ForestPlots - 1979-1980",
            "measurementMethod": "Name: Diameter at breast height - DBH | Definition:Diameter at breast height,, i.e. ca. 1.3 meters from the base of the trunk",
            "sourceCitation": null,
            "measurementLocationId": 28280,
            "measurementParentId": null,
            "decimalLatitude": -2.40371599,
            "decimalLongitude": -59.87090972
        }
    ]
}

media (GET)

Metadados de mídia (GET lista, POST cria, PUT atualiza).

ParâmetroObrigatórioDescriçãoExemplo
idNãoId unico ou lista separada por virgula para filtrar/selecionar registros.1,2,3
datasetNãoId ou sigla do dataset.3 ou FOREST1
fieldsNãoLista separada por vírgulas dos campos a serem incluídos na resposta ou uma palavra especial all/simple/raw, padrão: simpleid,scientificName ou all
individualNãoId, uuid ou organismID do indivíduo.4521 ou 2ff0e884-3d33
job_idNãoId do job para reutilizar affected_ids ou filtrar resultados.1024
limitNãoQuantidade maxima de registros retornados.100
locationNãoId ou nome do local.Parcela 25ha ou 55
location_rootNãoId/nome do local incluindo descendentes.Amazonas ou 10
media_idNãoId numerico de mídia.88
media_uuidNãoUUID da mídia.a3f0a4ac-6b5b-11ed-b8c0-0242ac120002
offsetNãoA posição inicial do conjunto de registros a ser exportado. Usado em conjunto com limit para limitar os resultados.10000
personNãoId/abreviação/nome/email de pessoa (aceita lista com | ou ;).Silva, J.B.|Costa, M.
projectNãoId ou sigla do projeto.PDBFF ou 2
save_jobNãoSe 1, salva a consulta como job para baixar depois via userjobs + get_file = 11
tagNãoTag/número/código do indivíduo.A-1234
taxonNãoId ou nome canônico do taxon (lista aceita).Licaria cannela,Licaria armeniaca ou 456,789
taxon_rootNãoId/nome de taxon incluindo descendentes.Lauraceae
uuidNão
voucherNãoId do voucher para filtrar measurements.102

Campos retornados

Campos (simple): id, model_type, model_id, basisOfRecord, recordedBy, recordedDate, dwcType, resourceRelationship, resourceRelationshipID, relationshipOfResource, scientificName, family, datasetName, projectName, taggedWith, accessRights, license, file_name, file_url, citation, uuid

Campos (all): id, model_type, model_id, basisOfRecord, recordedBy, recordedDate, dwcType, resourceRelationship, resourceRelationshipID, relationshipOfResource, scientificName, family, datasetName, projectName, taggedWith, accessRights, bibliographicCitation, license, file_name, file_url, citation, uuid, bibtex, userName, created_at

Exemplo de resposta

{
    "meta": {
        "odb_version": "0.10.0-alpha1",
        "api_version": "v0",
        "server": "http://localhost/opendatabio"
    },
    "data": [
        {
            "id": 20211,
            "model_type": "App\\Models\\Individual",
            "model_id": 111785,
            "basisOfRecord": "MachineObservation",
            "recordedBy": "Francisco Javier Farroñay Pacaya",
            "recordedDate": "2025-03-09",
            "dwcType": "StillImage",
            "resourceRelationship": "Organism",
            "resourceRelationshipID": "3402-1134_Pereira_1986",
            "relationshipOfResource": "StillImage of ",
            "scientificName": "Sacoglottis guianensis",
            "family": "Humiriaceae",
            "datasetName": "Unknown dataset",
            "projectName": "Projeto Dinâmica Biológica de Fragmentos Florestais",
            "taggedWith": "Folha abaxial",
            "accessRights": "Open access.",
            "bibliographicCitation": "Sacoglottis guianensis (Humiriaceae). (2025). By Francisco Javier Farroñay Pacaya. Collection: Pereira, M.J.R. #3402-1134 on 1986-01-24, from Quadrante 52, Parcela 3402-3, Reserva 3402, Cabo Frio, Fazenda Porto Alegre, Amazonas, Brasil (PDBFF). Project: PDBFF-Data. Instituto Nacional de Pesquisas da Amazônia (INPA), Manaus, Amazonas, Brasil. Type: Image. License: CC-BY-NC-SA 4.0. uuid: inpa-odb-3f139ba4-f22b-42d8-9e74-c340309061c2, url: http://localhost/opendatabio",
            "license": "CC-BY-NC-SA 4.0",
            "file_name": "67ce28cd76f4a.jpg",
            "file_url": "http://localhost/opendatabio/storage/media/20211/67ce28cd76f4a.jpg",
            "citation": "Sacoglottis guianensis (Humiriaceae). (2025). By Francisco Javier Farroñay Pacaya. Collection: Pereira, M.J.R. #3402-1134 on 1986-01-24, from Quadrante 52, Parcela 3402-3, Reserva 3402, Cabo Frio, Fazenda Porto Alegre, Amazonas, Brasil (PDBFF). Project: PDBFF-Data. Instituto Nacional de Pesquisas da Amazônia (INPA), Manaus, Amazonas, Brasil. Type: Image. License: CC-BY-NC-SA 4.0. uuid: inpa-odb-3f139ba4-f22b-42d8-9e74-c340309061c2, url: http://localhost/opendatabio",
            "uuid": "3f139ba4-f22b-42d8-9e74-c340309061c2",
            "bibtex": "@misc{Farronay_2025_20211,\n{\n    \"title\": \" Sacoglottis guianensis (Humiriaceae)\",\n    \"year\": \"(2025)\",\n    \"author\": \"Francisco Javier Farroñay Pacaya\",\n    \"howpublished\": \"{http:\\/\\/localhost\\/opendatabio\\/media\\/uuid\\/3f139ba4-f22b-42d8-9e74-c340309061c2}\",\n    \"license\": \"CC-BY-NC-SA 4.0\",\n    \"note\": \"Type: Image; Collection: Pereira, M.J.R. #3402-1134 on 1986-01-24, from Quadrante 52, Parcela 3402-3, Reserva 3402, Cabo Frio, Fazenda Porto Alegre, Amazonas, Brasil (PDBFF); Coordinates: POINT(-59.91500315727877 -2.3929141688648765); License: CC-BY-NC-SA 4.0; Project: PDBFF-Data.; Accessed: 2026-02-04\",\n    \"publisher\": \"Instituto Nacional de Pesquisas da Amazônia (INPA), Manaus, Amazonas, Brasil\"\n}\n}",
            "userName": "example",
            "created_at": "2025-03-09T23:48:29.000000Z"
        }
    ]
}

persons (GET)

Pessoas (GET lista, POST cria, PUT atualiza).

ParâmetroObrigatórioDescriçãoExemplo
idNãoId unico ou lista separada por virgula para filtrar/selecionar registros.1,2,3
abbrevNãoBusca por abreviação de pessoa.Silva, J.B.
emailNãoEndereco de email.user@example.org
fieldsNãoLista separada por vírgulas dos campos a serem incluídos na resposta ou uma palavra especial all/simple/raw, padrão: simpleid,scientificName ou all
job_idNãoId do job para reutilizar affected_ids ou filtrar resultados.1024
limitNãoQuantidade maxima de registros retornados.100
nameNãoParametro generico de nome (taxon completo, local, export_name de trait, etc.).Ocotea guianensis
offsetNãoA posição inicial do conjunto de registros a ser exportado. Usado em conjunto com limit para limitar os resultados.10000
save_jobNãoSe 1, salva a consulta como job para baixar depois via userjobs + get_file = 11
searchNãoParametro de busca de texto.Silva

Campos retornados

Campos (simple): id, full_name, abbreviation, emailAddress, institution, notes

Campos (all): id, full_name, abbreviation, emailAddress, institution, notes

Exemplo de resposta

{
    "meta": {
        "odb_version": "0.10.0-alpha1",
        "api_version": "v0",
        "server": "http://localhost/opendatabio"
    },
    "data": [
        {
            "id": 3127,
            "full_name": "Raimundo Afeganistão",
            "abbreviation": "AFEGANISTÃO, R.",
            "emailAddress": null,
            "institution": null,
            "notes": "PDBFF"
        },
        {
            "id": 14,
            "full_name": "Maria de Fátima  Agra",
            "abbreviation": "Agra, M.F.",
            "emailAddress": null,
            "institution": null,
            "notes": null
        },
        {
            "id": 15,
            "full_name": "J. L. A. Aguiar Jr",
            "abbreviation": "Aguiar Jr., J.L.A.",
            "emailAddress": null,
            "institution": null,
            "notes": null
        }
    ]
}

projects (GET)

Projetos (GET lista).

ParâmetroObrigatórioDescriçãoExemplo
idNãoId unico ou lista separada por virgula para filtrar/selecionar registros.1,2,3
fieldsNãoLista separada por vírgulas dos campos a serem incluídos na resposta ou uma palavra especial all/simple/raw, padrão: simpleid,scientificName ou all
job_idNãoId do job para reutilizar affected_ids ou filtrar resultados.1024
limitNãoQuantidade maxima de registros retornados.100
offsetNãoA posição inicial do conjunto de registros a ser exportado. Usado em conjunto com limit para limitar os resultados.10000
save_jobNãoSe 1, salva a consulta como job para baixar depois via userjobs + get_file = 11
searchNãoParametro de busca de texto.Silva
tagNãoTag/número/código do indivíduo.A-1234

Campos retornados

Campos (simple): id, acronym, name, description

Campos (all): id, acronym, name, description, pages, urls, created_at, updated_at

Exemplo de resposta

{
    "meta": {
        "odb_version": "0.10.0-alpha1",
        "api_version": "v0",
        "server": "http://localhost/opendatabio"
    },
    "data": [
        {
            "id": 1,
            "acronym": "PDBFF-Data",
            "name": "Projeto Dinâmica Biológica de Fragmentos Florestais",
            "description": "Este espaço agrega conjuntos de dados de monitoramentos e pesquisas realizadas nas áreas amostrais do PDBFF,  localizadas na Área de Relevante Interesse Ecológico - ARIE PDBFF.",
            "pages": {
                "en": null,
                "pt-br": null
            },
            "urls": [
                {
                    "url": "https://alfa-pdbff.site/",
                    "label": null,
                    "icon": "fa-solid fa-globe"
                }
            ],
            "created_at": "2022-10-31T07:01:18.000000Z",
            "updated_at": "2023-11-17T21:08:55.000000Z"
        }
    ]
}

taxons (GET)

Nomes taxonômicos (GET lista, POST cria).

ParâmetroObrigatórioDescriçãoExemplo
idNãoId unico ou lista separada por virgula para filtrar/selecionar registros.1,2,3
bibreferenceNãoId ou bibkey da referência.34
biocollectionNãoId, nome ou sigla da biocoleção.INPA
datasetNãoId ou sigla do dataset.3 ou FOREST1
externalNãoFlag para incluir ids externos (Tropicos, IPNI, etc.).1
fieldsNãoLista separada por vírgulas dos campos a serem incluídos na resposta ou uma palavra especial all/simple/raw, padrão: simpleid,scientificName ou all
job_idNãoId do job para reutilizar affected_ids ou filtrar resultados.1024
levelNãoCódigo ou string do nível taxonômico.210 ou species
limitNãoQuantidade maxima de registros retornados.100
location_rootNãoId/nome do local incluindo descendentes.Amazonas ou 10
nameNãoParametro generico de nome (taxon completo, local, export_name de trait, etc.).Ocotea guianensis
offsetNãoA posição inicial do conjunto de registros a ser exportado. Usado em conjunto com limit para limitar os resultados.10000
personNãoId/abreviação/nome/email de pessoa (aceita lista com | ou ;).Silva, J.B.|Costa, M.
projectNãoId ou sigla do projeto.PDBFF ou 2
rootNãoId raiz para consultas hierarquicas (taxon ou local).120
save_jobNãoSe 1, salva a consulta como job para baixar depois via userjobs + get_file = 11
taxon_rootNãoId/nome de taxon incluindo descendentes.Lauraceae
traitNãoId ou export_name do trait para filtro.DBH
validNãoQuando 1 retorna apenas nomes taxonômicos validos.1
vernacularNãoId ou nome de vernacular para filtrar individuals.castanha|12

Campos retornados

Campos (simple): id, parent_id, author_id, scientificName, taxonRank, scientificNameAuthorship, namePublishedIn, parentName, family, taxonRemarks, taxonomicStatus, scientificNameID, basisOfRecord

Campos (all): id, senior_id, parent_id, author_id, scientificName, taxonRank, scientificNameAuthorship, namePublishedIn, parentName, family, higherClassification, taxonRemarks, taxonomicStatus, acceptedNameUsage, acceptedNameUsageID, parentNameUsage, scientificNameID, basisOfRecord

Exemplo de resposta

{
    "meta": {
        "odb_version": "0.10.0-alpha1",
        "api_version": "v0",
        "server": "http://localhost/opendatabio"
    },
    "data": [
        {
            "id": 16332,
            "senior_id": null,
            "parent_id": 16331,
            "author_id": null,
            "scientificName": "Aiouea grandifolia",
            "taxonRank": "Species",
            "scientificNameAuthorship": "van der Werff",
            "namePublishedIn": null,
            "parentName": "Aiouea",
            "family": "Lauraceae",
            "higherClassification": "Eukaryota > Plantae > Viridiplantae > Embryophytes > Spermatopsida > Angiosperms > Magnoliidae > Laurales > Lauraceae > Aiouea",
            "taxonRemarks": null,
            "taxonomicStatus": "accepted",
            "acceptedNameUsage": null,
            "acceptedNameUsageID": null,
            "parentNameUsage": "Aiouea",
            "scientificNameID": "https://tropicos.org/Name/17806050 | https://www.gbif.org/species/4175896",
            "basisOfRecord": "Taxon"
        }
    ]
}

traits (GET)

Definições de traits (GET lista, POST cria).

ParâmetroObrigatórioDescriçãoExemplo
idNãoId unico ou lista separada por virgula para filtrar/selecionar registros.1,2,3
bibreferenceNãoId ou bibkey da referência.34
categoriesNãoLista JSON de categorias de trait com lang/rank/name/description.[{\"lang\":\"en\",\"rank\":1,\"name\":\"small\"}]
datasetNãoId ou sigla do dataset.3 ou FOREST1
fieldsNãoLista separada por vírgulas dos campos a serem incluídos na resposta ou uma palavra especial all/simple/raw, padrão: simpleid,scientificName ou all
job_idNãoId do job para reutilizar affected_ids ou filtrar resultados.1024
languageNãoId/código/nome do idiomaen ou 1 ou english ou portugues ou pt-br
limitNãoQuantidade maxima de registros retornados.100
nameNãoParametro generico de nome (taxon completo, local, export_name de trait, etc.).Ocotea guianensis
object_typeNãoTipo do objeto medido: Individual, Location, Taxon, Voucher ou Media.Individual
offsetNãoA posição inicial do conjunto de registros a ser exportado. Usado em conjunto com limit para limitar os resultados.10000
save_jobNãoSe 1, salva a consulta como job para baixar depois via userjobs + get_file = 11
searchNãoParametro de busca de texto.Silva
tagNãoTag/número/código do indivíduo.A-1234
taxonNãoId ou nome canônico do taxon (lista aceita).Licaria cannela,Licaria armeniaca ou 456,789
taxon_rootNãoId/nome de taxon incluindo descendentes.Lauraceae
traitNãoId ou export_name do trait para filtro.DBH
typeNãoParametro generico type (código do trait ou tipo de vernacular: use/generic/etimology).use ou 10

Campos retornados

Campos (simple): id, type, typename, export_name, unit, range_min, range_max, link_type, value_length, name, description, objects, measurementType, categories

Campos (all): id, type, typename, export_name, measurementType, measurementUnit, range_min, range_max, link_type, value_length, name, description, objects, measurementMethod, MeasurementTypeBibkeys, TaggedWith, categories

Exemplo de resposta

{
    "meta": {
        "odb_version": "0.10.0-alpha1",
        "api_version": "v0",
        "server": "http://localhost/opendatabio"
    },
    "data": [
        {
            "id": 206,
            "type": 1,
            "typename": "QUANT_REAL",
            "export_name": "treeDbh",
            "measurementType": "treeDbh",
            "measurementUnit": "cm",
            "range_min": 0.1,
            "range_max": 700,
            "link_type": null,
            "value_length": null,
            "name": "Diâmetro à altura do peito – DAP",
            "description": "Diâmetro à altura do peito, i.e. medido a ca. 1.3m desde a base do caule",
            "objects": "App\\Models\\Individual | App\\Models\\Voucher | App\\Models\\Location | App\\Models\\Taxon | App\\Models\\Media",
            "measurementMethod": "Name: Diameter at breast height - DBH | Definition:Diameter at breast height,, i.e. ca. 1.3 meters from the base of the trunk",
            "MeasurementTypeBibkeys": "",
            "TaggedWith": "",
            "categories": null
        },
        {
            "id": 207,
            "type": 1,
            "typename": "QUANT_REAL",
            "export_name": "treeDbhPom",
            "measurementType": "treeDbhPom",
            "measurementUnit": "m",
            "range_min": 0,
            "range_max": 15,
            "link_type": null,
            "value_length": null,
            "name": "Ponto de medição do DAP",
            "description": "Ponto de medição do DAP, necessário quando impossível medir a 1.3 m",
            "objects": "App\\Models\\Individual",
            "measurementMethod": "Name: DBH Point of Measurement | Definition:DAP measuring height, necessary when impossible to measure at 1.3 m",
            "MeasurementTypeBibkeys": "",
            "TaggedWith": "",
            "categories": null
        },
        {
            "id": 524,
            "type": 2,
            "typename": "CATEGORICAL",
            "export_name": "stemType",
            "measurementType": "stemType",
            "measurementUnit": null,
            "range_min": null,
            "range_max": null,
            "link_type": null,
            "value_length": null,
            "name": "Tipo de fuste",
            "description": "Tipo de fuste",
            "objects": "App\\Models\\Voucher | App\\Models\\Individual | App\\Models\\Taxon",
            "measurementMethod": "Name: Type of stem | Definition:Type of stem | Categories: CategoryName: Main stem | Definition:The main trunk, usually the thickest. | CategoryName: Secondary stem | Definition:A secondary trunk, there is a thicker one, which defines the area better. A shoot below 1.3 m high is a secondary trunk.",
            "MeasurementTypeBibkeys": "",
            "TaggedWith": "",
            "categories": [
                {
                    "id": 12990,
                    "name": "Fuste principal",
                    "description": "O tronco principal, geralmente o mais grosso.",
                    "rank": 1,
                    "belongs_to_trait": "stemType"
                },
                {
                    "id": 12991,
                    "name": "Fuste secundário",
                    "description": "Um tronco secundário, há outro mais grosso, que define melhor a área. Um rebroto abaixo de 1.3 m de altura é um tronco secundário.",
                    "rank": 2,
                    "belongs_to_trait": "stemType"
                }
            ]
        }
    ]
}

vernaculars (GET)

Nomes vernáculos (GET lista, POST cria).

ParâmetroObrigatórioDescriçãoExemplo
idNãoId unico ou lista separada por virgula para filtrar/selecionar registros.1,2,3
fieldsNãoLista separada por vírgulas dos campos a serem incluídos na resposta ou uma palavra especial all/simple/raw, padrão: simpleid,scientificName ou all
individualNãoId, uuid ou organismID do indivíduo.4521 ou 2ff0e884-3d33
job_idNãoId do job para reutilizar affected_ids ou filtrar resultados.1024
limitNãoQuantidade maxima de registros retornados.100
locationNãoId ou nome do local.Parcela 25ha ou 55
location_rootNãoId/nome do local incluindo descendentes.Amazonas ou 10
offsetNãoA posição inicial do conjunto de registros a ser exportado. Usado em conjunto com limit para limitar os resultados.10000
save_jobNãoSe 1, salva a consulta como job para baixar depois via userjobs + get_file = 11
taxonNãoId ou nome canônico do taxon (lista aceita).Licaria cannela,Licaria armeniaca ou 456,789
taxon_rootNãoId/nome de taxon incluindo descendentes.Lauraceae

Campos retornados

Campos (simple): id, name, languageName, notes, locationsList, taxonsList, individualsList, citationsArray

Campos (all): id, name, languageName, languageCode, notes, taxonsList, taxonsListArray, individualsList, individualsListArray, locationsList, locationsListArray, variantsList, variantsListArray, citationsArray, createdBy, created_at, updated_at

Exemplo de resposta

{
    "meta": {
        "odb_version": "0.10.0-alpha1",
        "api_version": "v0",
        "server": "http://localhost/opendatabio"
    },
    "data": [
        {
            "id": 1,
            "name": "itaúba-preta",
            "languageName": "Portuguese",
            "languageCode": "pt-br",
            "notes": null,
            "taxonsList": "Mezilaurus duckei",
            "taxonsListArray": [
                {
                    "id": 19774,
                    "scientificName": "Mezilaurus duckei",
                    "family": "Lauraceae"
                }
            ],
            "individualsList": "7739_Macedo_2023",
            "individualsListArray": [
                {
                    "id": 510747,
                    "uuid": "c75d9233-f437-11ef-b90b-9cb654b86224",
                    "organismId": "7739_Macedo_2023",
                    "scientificName": "Mezilaurus duckei",
                    "family": "Lauraceae"
                }
            ],
            "locationsList": null,
            "locationsListArray": [],
            "variantsList": "itaúba",
            "variantsListArray": [
                {
                    "id": 2,
                    "name": "itaúba",
                    "languageName": "Tupi",
                    "languageCode": "tup"
                }
            ],
            "citationsArray": [
                {
                    "id": 2,
                    "citation": "ita = pedra; uba = árvore;  preta em referência a cor da madeira",
                    "bibreference_id": null,
                    "bibreference_name": null,
                    "notes": null,
                    "type": "etimology",
                    "createdBy": "example"
                }
            ],
            "createdBy": "example",
            "created_at": "2025-12-15T20:17:16.000000Z",
            "updated_at": "2025-12-15T21:04:53.000000Z"
        }
    ]
}

vouchers (GET)

Vouchers de coleção (GET lista, POST cria, PUT atualiza).

ParâmetroObrigatórioDescriçãoExemplo
idNãoId unico ou lista separada por virgula para filtrar/selecionar registros.1,2,3
bibreferenceNãoId ou bibkey da referência.34
bibreference_idNãoLista de ids de BibReference para filtrar vouchers.10,11
biocollectionNãoId, nome ou sigla da biocoleção.INPA
biocollection_idNãoLista de ids de biocoleção para filtrar vouchers.1,5
collectorNãoColetor(es) id, abreviação, nome ou email. Separe múltiplos com | ou ;, primeiro e o principal.Silva, J.B.|Costa, M.
datasetNãoId ou sigla do dataset.3 ou FOREST1
date_maxNãoFiltra registros ate esta data (AAAA-MM-DD).2024-12-31
date_minNãoFiltra registros a partir desta data (AAAA-MM-DD).2020-01-01
fieldsNãoLista separada por vírgulas dos campos a serem incluídos na resposta ou uma palavra especial all/simple/raw, padrão: simpleid,scientificName ou all
individualNãoId, uuid ou organismID do indivíduo.4521 ou 2ff0e884-3d33
job_idNãoId do job para reutilizar affected_ids ou filtrar resultados.1024
limitNãoQuantidade maxima de registros retornados.100
locationNãoId ou nome do local.Parcela 25ha ou 55
location_rootNãoId/nome do local incluindo descendentes.Amazonas ou 10
main_collectorNãoBooleano (1) para filtrar vouchers apenas pelo coletor principal.1
numberNãoNúmero/código de coletor (voucher ou tag quando diferente).1234A
odbrequest_idNãoFiltra indivíduos vinculados a um request id.12
offsetNãoA posição inicial do conjunto de registros a ser exportado. Usado em conjunto com limit para limitar os resultados.10000
personNãoId/abreviação/nome/email de pessoa (aceita lista com | ou ;).Silva, J.B.|Costa, M.
projectNãoId ou sigla do projeto.PDBFF ou 2
save_jobNãoSe 1, salva a consulta como job para baixar depois via userjobs + get_file = 11
taxonNãoId ou nome canônico do taxon (lista aceita).Licaria cannela,Licaria armeniaca ou 456,789
taxon_rootNãoId/nome de taxon incluindo descendentes.Lauraceae
traitNãoId ou export_name do trait para filtro.DBH
vernacularNãoId ou nome de vernacular para filtrar individuals.castanha|12

Campos retornados

Campos (simple): id, individual_id, basisOfRecord, occurrenceID, organismID, collectionCode, catalogNumber, typeStatus, recordedByMain, recordNumber, recordedDate, recordedBy, scientificName, family, identificationQualifier, identifiedBy, dateIdentified, identificationRemarks, locationName, decimalLatitude, decimalLongitude, occurrenceRemarks, datasetName

Campos (all): id, individual_id, basisOfRecord, occurrenceID, organismID, collectionCode, catalogNumber, typeStatus, recordedByMain, recordNumber, recordedDate, recordedBy, scientificName, scientificNameAuthorship, taxonPublishedStatus, genus, family, identificationQualifier, identifiedBy, dateIdentified, identificationRemarks, locationName, higherGeography, decimalLatitude, decimalLongitude, georeferenceRemarks, occurrenceRemarks, datasetName, uuid

Exemplo de resposta

{
    "meta": {
        "odb_version": "0.10.0-alpha1",
        "api_version": "v0",
        "server": "http://localhost/opendatabio"
    },
    "data": [
        {
            "id": 72209,
            "individual_id": 306246,
            "basisOfRecord": "PreservedSpecimens",
            "occurrenceID": "2639.Spruce.K.K000640463",
            "organismID": "2639_Spruce_1852",
            "collectionCode": "K",
            "catalogNumber": "K000640463",
            "typeStatus": "Tipo",
            "recordedByMain": "Spruce, R.",
            "recordNumber": "2639",
            "recordedDate": "1852-10",
            "recordedBy": "Spruce, R.",
            "scientificName": "Ecclinusa lanceolata",
            "scientificNameAuthorship": "(Mart. & Eichler) Pierre",
            "taxonPublishedStatus": "published",
            "genus": "Ecclinusa",
            "family": "Sapotaceae",
            "identificationQualifier": "",
            "identifiedBy": "Spruce, R.",
            "dateIdentified": "1852-10-00",
            "identificationRemarks": "",
            "locationName": "São Gabriel da Cachoeira",
            "higherGeography": "Brasil > Amazonas > São Gabriel da Cachoeira",
            "decimalLatitude": 1.1841927,
            "decimalLongitude": -66.80167715,
            "georeferenceRemarks": "decimal coordinates are the CENTROID of the footprintWKT geometry",
            "occurrenceRemarks": "OrganismRemarks = prope Panure ad Rio Vaupes Amazonas, Brazil",
            "datasetName": "Exsicatas LABOTAM",
            "uuid": "6302316f-2b48-43b5-816b-005df70d15c9"
        }
    ]
}

userjobs (GET)

Jobs em background (importações/exportações) (GET lista).

ParâmetroObrigatórioDescriçãoExemplo
idNãoId unico ou lista separada por virgula para filtrar/selecionar registros.1,2,3
fieldsNãoLista separada por vírgulas dos campos a serem incluídos na resposta ou uma palavra especial all/simple/raw, padrão: simpleid,scientificName ou all
get_fileNãoQuando 1 com userjobs id, retorna o arquivo salvo.1
limitNãoQuantidade maxima de registros retornados.100
offsetNãoA posição inicial do conjunto de registros a ser exportado. Usado em conjunto com limit para limitar os resultados.10000
statusNãoFiltro de status de job (Submitted, Processing, Success, Failed, Cancelled).Success

Campos retornados

Campos (simple): id, dispatcher, status, percentage, created_at, affected_ids, affected_model

Campos (all): id, dispatcher, status, percentage, created_at, updated_at, affected_ids, affected_model, log

Exemplo de resposta

{
    "meta": {
        "odb_version": "0.10.0-alpha1",
        "api_version": "v0",
        "server": "http://localhost/opendatabio"
    },
    "data": [
        {
            "id": 23652,
            "dispatcher": "App\\Jobs\\BatchUpdateIndividuals",
            "status": "Success",
            "percentage": "100%",
            "created_at": "2025-12-10T14:36:25.000000Z",
            "updated_at": "2025-12-10T14:36:28.000000Z",
            "affected_ids": [
                86136,
                57362,
                85053,
                72256,
                74543
            ],
            "affected_model": "App\\Models\\Individual",
            "log": "[]"
        }
    ]
}

activities (GET)

Lista entradas do log de atividades.

ParâmetroObrigatórioDescriçãoExemplo
idNãoId unico ou lista separada por virgula para filtrar/selecionar registros.1,2,3
descriptionNãoDescrição em texto ou mapa de traducao.{\"en\":\"Leaf length\",\"pt-br\":\"Comprimento da folha\"}
fieldsNãoLista separada por vírgulas dos campos a serem incluídos na resposta ou uma palavra especial all/simple/raw, padrão: simpleid,scientificName ou all
individualNãoId, uuid ou organismID do indivíduo.4521 ou 2ff0e884-3d33
languageNãoId/código/nome do idiomaen ou 1 ou english ou portugues ou pt-br
limitNãoQuantidade maxima de registros retornados.100
locationNãoId ou nome do local.Parcela 25ha ou 55
log_nameNãoFiltro de activity log name.default
measurementNãoFiltro de atividade: id de measurement.55
offsetNãoA posição inicial do conjunto de registros a ser exportado. Usado em conjunto com limit para limitar os resultados.10000
save_jobNãoSe 1, salva a consulta como job para baixar depois via userjobs + get_file = 11
subjectNãoFiltro de atividade: tipo do subject (basename da classe).Individual
subject_idNãoFiltro de atividade: id do subject.12
taxonNãoId ou nome canônico do taxon (lista aceita).Licaria cannela,Licaria armeniaca ou 456,789
taxon_rootNãoId/nome de taxon incluindo descendentes.Lauraceae
voucherNãoId do voucher para filtrar measurements.102

Campos retornados

Campos (simple): id, log_name, description, subject_type, subject_name, subject_id, modified_by, properties, created_at, updated_at

Campos (all): id, log_name, description, subject_type, subject_id, subject_name, modified_by, properties, created_at, updated_at

Exemplo de resposta

{
    "meta": {
        "odb_version": "0.10.0-alpha1",
        "api_version": "v0",
        "server": "http://localhost/opendatabio"
    },
    "data": [
        {
            "field_key": "taxon_id",
            "field": "Taxon",
            "old_value": "Burseraceae",
            "new_value": "Protium hebetatum forma.b.fito",
            "id": 1411696,
            "log_name": "individual",
            "description": "identification updated",
            "subject_type": "App\\Models\\Individual",
            "subject_id": 301705,
            "subject_name": null,
            "modified_by": "example"
        },
        {
            "field_key": "person_id",
            "field": "Person",
            "old_value": "Macedo, M.T.S",
            "new_value": "Pilco, M.V.",
            "id": 1411696,
            "log_name": "individual",
            "description": "identification updated",
            "subject_type": "App\\Models\\Individual",
            "subject_id": 301705,
            "subject_name": null,
            "modified_by": "example"
        },
        {
            "field_key": "notes",
            "field": "Notes",
            "old_value": "Identificação feita em campo, anotada na planilha de dados.",
            "new_value": null,
            "id": 1411696,
            "log_name": "individual",
            "description": "identification updated",
            "subject_type": "App\\Models\\Individual",
            "subject_id": 301705,
            "subject_name": null,
            "modified_by": "example"
        },
        {
            "field_key": "date",
            "field": "Date",
            "old_value": "2022-06-17",
            "new_value": "2022-11-23",
            "id": 1411696,
            "log_name": "individual",
            "description": "identification updated",
            "subject_type": "App\\Models\\Individual",
            "subject_id": 301705,
            "subject_name": null,
            "modified_by": "example"
        }
    ]
}

tags (GET)

Tags/palavras-chave (GET lista).

ParâmetroObrigatórioDescriçãoExemplo
idNãoId unico ou lista separada por virgula para filtrar/selecionar registros.1,2,3
datasetNãoId ou sigla do dataset.3 ou FOREST1
fieldsNãoLista separada por vírgulas dos campos a serem incluídos na resposta ou uma palavra especial all/simple/raw, padrão: simpleid,scientificName ou all
job_idNãoId do job para reutilizar affected_ids ou filtrar resultados.1024
languageNãoId/código/nome do idiomaen ou 1 ou english ou portugues ou pt-br
limitNãoQuantidade maxima de registros retornados.100
nameNãoParametro generico de nome (taxon completo, local, export_name de trait, etc.).Ocotea guianensis
offsetNãoA posição inicial do conjunto de registros a ser exportado. Usado em conjunto com limit para limitar os resultados.10000
projectNãoId ou sigla do projeto.PDBFF ou 2
save_jobNãoSe 1, salva a consulta como job para baixar depois via userjobs + get_file = 11
searchNãoParametro de busca de texto.Silva
traitNãoId ou export_name do trait para filtro.DBH

Campos retornados

Campos (simple): id, name, description

Campos (all): id, name, description, counts

Exemplo de resposta

{
    "meta": {
        "odb_version": "0.10.0-alpha1",
        "api_version": "v0",
        "server": "http://localhost/opendatabio"
    },
    "data": [
        {
            "id": 11,
            "name": "Folhas adaxial",
            "description": "Images of the adaxial surface of leaves",
            "counts": {
                "Media": 1852,
                "Project": 0,
                "Dataset": 0,
                "ODBTrait": 0
            }
        },
        {
            "id": 12,
            "name": "Folha forma",
            "description": "Imagem mostrando uma folha ou o formato da folha.",
            "counts": {
                "Media": 713,
                "Project": 0,
                "Dataset": 0,
                "ODBTrait": 0
            }
        },
        {
            "id": 13,
            "name": "Frutos",
            "description": "Imagens com frutos",
            "counts": {
                "Media": 2595,
                "Project": 0,
                "Dataset": 0,
                "ODBTrait": 0
            }
        }
    ]
}

Última modificação December 16, 2025: Improved sync between odb schema and docs (c5bc51e)