Obter dados - GET

Como obter dados usando a GET API!

Parâmetros GET compartilhados

ParâmetroObrigatórioDescriçãoExemplo
idNãoId unico ou lista separada por virgula para filtrar/selecionar registros.1,2,3
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
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
save_jobNãoSe 1, salva a consulta como job para baixar depois via userjobs + get_file = 11

Selecionar campos da resposta

O parâmetro fields controla as colunas retornadas:

  • simple é o perfil padrão e reúne os campos mais úteis para o uso comum;
  • all inclui campos adicionais, técnicos, relacionais ou mantidos por compatibilidade;
  • uma lista separada por vírgulas, como fields=id,uuid,scientificName, retorna apenas os campos solicitados.

Cada endpoint abaixo apresenta uma tabela com os campos de simple e all e o significado de cada coluna. As descrições vêm do mesmo schema usado pela aplicação. Quando um campo muda de sentido conforme o endpoint — por exemplo, x e y em Localidades e Indivíduos — a definição específica do endpoint é mostrada. Campos indicados como Darwin Core seguem o vocabulário de intercâmbio; campos indicados como locais são extensões do OpenDataBio.

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

O perfil simple é a resposta padrão; all acrescenta campos detalhados, técnicos ou de compatibilidade. Use o parâmetro fields para solicitar uma lista explícita.

CampoPerfisSignificado
idsimple / allIdentificador numérico interno do registro exportado nesta instalação OpenDataBio.
uuidsimple / allUUID estável do registro exportado.
bibkeysimple / allChave curta local OpenDataBio usada para identificar uma referência bibliográfica.
yearsimple / allAno de publicação de uma referência bibliográfica.
authorsimple / allTexto de autoria de uma referência bibliográfica ou nome taxonômico, dependendo do endpoint.
titlesimple / allTítulo de uma referência bibliográfica ou dataset, dependendo do endpoint.
doisimple / allDigital Object Identifier associado a uma referência bibliográfica.
urlsimple / allURL associada a uma referência bibliográfica.
bibtexsimple / allRepresentação BibTeX da referência bibliográfica ou citação de mídia.

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

O perfil simple é a resposta padrão; all acrescenta campos detalhados, técnicos ou de compatibilidade. Use o parâmetro fields para solicitar uma lista explícita.

CampoPerfisSignificado
idsimple / allIdentificador numérico interno do registro exportado nesta instalação OpenDataBio.
uuidsimple / allUUID estável do registro exportado.
acronymsimple / allSigla local OpenDataBio de um projeto ou biocoleção.
namesimple / allNome local OpenDataBio do recurso exportado.
irnsimple / allNúmero de registro institucional local OpenDataBio de uma biocoleção.
countryallNome ou código do país associado a uma localidade, coleção ou linha de exportação BRAHMS.
cityallCidade local OpenDataBio registrada para uma biocoleção.
addressallTexto de endereço local OpenDataBio registrado para uma biocoleção.

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 versões publicadas de datasets (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
has_versionsNãoQuando 1, retorna apenas datasets que possuem versões publicas.1
include_urlNãoQuando 1 com list_versions, inclui URL do archive.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
version_idNãoId da versão de dataset para listar ou baixar.34
version_uuidNãoUUID da versão de dataset para listar ou baixar.550e8400-e29b-41d4-a716-446655440000

Campos retornados

O perfil simple é a resposta padrão; all acrescenta campos detalhados, técnicos ou de compatibilidade. Use o parâmetro fields para solicitar uma lista explícita.

CampoPerfisSignificado
idsimple / allIdentificador numérico interno do registro exportado nesta instalação OpenDataBio.
uuidsimple / allUUID estável do registro exportado.
namesimple / allNome local OpenDataBio do recurso exportado.
titlesimple / allTítulo de uma referência bibliográfica ou dataset, dependendo do endpoint.
projectNamesimple / allNome ou sigla do projeto ligado ao registro ou dataset.
project_idsimple / allIdentificador numérico interno do projeto ligado ao registro ou dataset.
project_uuidsimple / allUUID estável do projeto ligado ao registro ou dataset.
descriptionsimple / allTexto descritivo local OpenDataBio do recurso exportado.
notessimple / allNotas locais OpenDataBio associadas ao recurso exportado.
contactEmailsimple / allE-mail de contato local OpenDataBio configurado para o dataset.
taggedWidthsimple / allLista local OpenDataBio de tags associadas a um dataset. Este nome de campo legado é mantido por compatibilidade da API.
policyCodesimple / allCódigo compacto da política derivado da licença do dataset e das obrigações de uso.
privacyLevelallNível de acesso interno local OpenDataBio configurado para o dataset; não é licença.
policyallTexto completo da política de dados armazenado localmente para um dataset.
measurements_countallContagem local OpenDataBio de medições ligadas ao dataset.
policyUrlallURL onde a política completa do dataset ou versão pode ser consultada.
policySummaryallResumo curto, em linguagem simples, das permissões e obrigações de uso.

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

O perfil simple é a resposta padrão; all acrescenta campos detalhados, técnicos ou de compatibilidade. Use o parâmetro fields para solicitar uma lista explícita.

CampoPerfisSignificado
idsimple / allIdentificador numérico interno do registro exportado nesta instalação OpenDataBio.
uuidsimple / allUUID estável do registro exportado.
dataset_idsimple / allIdentificador numérico interno do dataset que governa o registro exportado.
basisOfRecordsimple / allColuna Darwin Core: valor basisOfRecord indicando o tipo geral de registro biológico.
organismIDsimple / allColuna Darwin Core: identificador estável do organismo/indivíduo, formatado pelo OpenDataBio como odb:{installation}:individual:{uuid}.
organismNamesimple / allColuna Darwin Core: rótulo legível do organismo ou registro de indivíduo.
recordedByMainsimple / allColetor ou observador principal responsável pelo registro.
recordNumbersimple / allColuna Darwin Core: número de coleta ou observação.
eventDatesimple / allColuna Darwin Core: data ou intervalo em que ocorreu o evento de coleta, observação, captura da mídia ou ocorrência.
familysimple / allColuna taxonômica Darwin Core: família associada ao táxon exportado ou organismo identificado.
scientificNamesimple / allColuna taxonômica Darwin Core: nome científico associado ao registro no momento da exportação.
identificationQualifiersimple / allColuna Darwin Core: qualificador que expressa incerteza ou condição da identificação.
identifiedBysimple / allColuna Darwin Core: pessoa ou pessoas responsáveis pela identificação taxonômica.
dateIdentifiedsimple / allColuna Darwin Core: data em que a identificação taxonômica foi feita.
locationNamesimple / allRótulo de localidade compatível com Darwin Core usado pelo OpenDataBio para a localidade associada ao registro.
locationParentNamesimple / allNome da localidade pai que contém a localidade do registro.
higherGeographysimple / allColuna Darwin Core: contexto geográfico superior da localidade, como localidades parentais ou hierarquia administrativa.
decimalLatitudesimple / allColuna Darwin Core: latitude em graus decimais, quando coordenadas estão disponíveis para distribuição.
decimalLongitudesimple / allColuna Darwin Core: longitude em graus decimais, quando coordenadas estão disponíveis para distribuição.
xsimple / allCampo local OpenDataBio para posição de ocorrência: coordenada cartesiana X do indivíduo dentro da parcela, transecto ou localidade parental.
ysimple / allCampo local OpenDataBio para posição de ocorrência: coordenada cartesiana Y do indivíduo dentro da parcela, transecto ou localidade parental. Em transectos, o sinal pode indicar o lado do transecto.
gxsimple / allCoordenada X projetada ou de grade local OpenDataBio da posição de um indivíduo, quando disponível.
gysimple / allCoordenada Y projetada ou de grade local OpenDataBio da posição de um indivíduo, quando disponível.
anglesimple / allAzimute local OpenDataBio, em graus, de um ponto de referência até a posição de ocorrência.
distancesimple / allDistância local OpenDataBio, em metros, de um ponto de referência até a posição de ocorrência.
datasetIDsimple / allColuna Darwin Core: identificador estável do dataset que governa o registro, formatado pelo OpenDataBio como odb:{installation}:dataset:{uuid}; inclui o UUID do dataset e os prefixos da instalação.
datasetNamesimple / allColuna Darwin Core: nome ou título do dataset que governa o registro exportado.
accessRightssimple / allColuna Darwin Core: informação legível sobre permissões, restrições e condições de uso do registro, derivada da licença e da política de dados do dataset que governa o registro.
policyCodesimple / allCódigo compacto da política derivado da licença do dataset e das obrigações de uso.
recordedDateallColuna legada OpenDataBio equivalente a Darwin Core eventDate. Mantida em exportações all por compatibilidade; prefira eventDate para interoperabilidade.
recordedByallColuna Darwin Core: coletores ou observadores associados ao registro.
scientificNameAuthorshipallColuna taxonômica Darwin Core: texto de autoria associado ao nome científico.
taxon_idallIdentificador numérico interno do nome taxonômico ligado.
taxon_uuidallUUID estável do nome taxonômico ligado.
identification_idallIdentificador numérico interno da identificação taxonômica ligada ao registro.
identification_uuidallUUID estável da identificação taxonômica ligada ao registro.
taxonPublishedStatusallStatus de publicação do nome taxonômico usado na identificação.
genusallColuna taxonômica Darwin Core: gênero associado ao táxon exportado ou organismo identificado.
identificationRemarksallColuna Darwin Core: notas associadas à identificação taxonômica.
identificationBiocollectionallBiocoleção usada como referência para a identificação, quando aplicável.
identificationBiocollectionReferenceallNúmero de catálogo ou referência na biocoleção usada para identificação.
location_idallIdentificador numérico interno da localidade ligada.
location_uuidallUUID estável da localidade ligada.
georeferenceRemarksallColuna Darwin Core: notas descrevendo origem das coordenadas, incerteza ou detalhes de georreferenciamento.
relatedLocationsallOutras localidades relacionadas ao registro, como parcelas, transectos ou localidades de ocorrência ligadas.
organismRemarksallColuna Darwin Core: observações sobre o organismo ou indivíduo.
policyUrlallURL onde a política completa do dataset ou versão pode ser consultada.
policySummaryallResumo curto, em linguagem simples, das permissões e obrigações de uso.

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

O perfil simple é a resposta padrão; all acrescenta campos detalhados, técnicos ou de compatibilidade. Use o parâmetro fields para solicitar uma lista explícita.

CampoPerfisSignificado
idsimple / allIdentificador numérico interno do registro exportado nesta instalação OpenDataBio.
uuidsimple / allUUID estável do registro exportado.
individual_idsimple / allIdentificador numérico interno do indivíduo ou organismo ligado.
individual_uuidsimple / allUUID estável do indivíduo ou organismo ligado.
location_idsimple / allIdentificador numérico interno da localidade ligada.
location_uuidsimple / allUUID estável da localidade ligada.
basisOfRecordsimple / allColuna Darwin Core: valor basisOfRecord indicando o tipo geral de registro biológico.
occurrenceIDsimple / allColuna Darwin Core: identificador estável do registro de ocorrência biológica. Uma ocorrência representa a presença/registro de um organismo ou táxon em uma localidade.
organismIDsimple / allColuna Darwin Core: identificador estável do organismo/indivíduo, formatado pelo OpenDataBio como odb:{installation}:individual:{uuid}.
organismNamesimple / allColuna Darwin Core: rótulo legível do organismo ou registro de indivíduo.
eventDatesimple / allColuna Darwin Core: data ou intervalo em que ocorreu o evento de coleta, observação, captura da mídia ou ocorrência.
locationNamesimple / allRótulo de localidade compatível com Darwin Core usado pelo OpenDataBio para a localidade associada ao registro.
higherGeographysimple / allColuna Darwin Core: contexto geográfico superior da localidade, como localidades parentais ou hierarquia administrativa.
decimalLatitudesimple / allColuna Darwin Core: latitude em graus decimais, quando coordenadas estão disponíveis para distribuição.
decimalLongitudesimple / allColuna Darwin Core: longitude em graus decimais, quando coordenadas estão disponíveis para distribuição.
xsimple / allCampo local OpenDataBio para posição de ocorrência: coordenada cartesiana X desta ocorrência do indivíduo dentro da parcela, transecto ou localidade parental.
ysimple / allCampo local OpenDataBio para posição de ocorrência: coordenada cartesiana Y desta ocorrência do indivíduo dentro da parcela, transecto ou localidade parental. Em transectos, o sinal pode indicar o lado do transecto.
anglesimple / allAzimute local OpenDataBio, em graus, de um ponto de referência até a posição de ocorrência.
distancesimple / allDistância local OpenDataBio, em metros, de um ponto de referência até a posição de ocorrência.
minimumElevationsimple / allColuna Darwin Core: limite inferior de elevação da ocorrência ou localidade, em metros.
occurrenceRemarkssimple / allColuna Darwin Core: observações sobre a ocorrência.
scientificNamesimple / allColuna taxonômica Darwin Core: nome científico associado ao registro no momento da exportação.
familysimple / allColuna taxonômica Darwin Core: família associada ao táxon exportado ou organismo identificado.
datasetIDsimple / allColuna Darwin Core: identificador estável do dataset que governa o registro, formatado pelo OpenDataBio como odb:{installation}:dataset:{uuid}; inclui o UUID do dataset e os prefixos da instalação.
datasetNamesimple / allColuna Darwin Core: nome ou título do dataset que governa o registro exportado.
accessRightssimple / allColuna Darwin Core: informação legível sobre permissões, restrições e condições de uso do registro, derivada da licença e da política de dados do dataset que governa o registro.
policyCodesimple / allCódigo compacto da política derivado da licença do dataset e das obrigações de uso.
occurrenceNameallRótulo legível de um registro de ocorrência.
recordedDateallColuna legada OpenDataBio equivalente a Darwin Core eventDate. Mantida em exportações all por compatibilidade; prefira eventDate para interoperabilidade.
georeferenceRemarksallColuna Darwin Core: notas descrevendo origem das coordenadas, incerteza ou detalhes de georreferenciamento.
organismRemarksallColuna Darwin Core: observações sobre o organismo ou indivíduo.
policyUrlallURL onde a política completa do dataset ou versão pode ser consultada.
policySummaryallResumo curto, em linguagem simples, das permissões e obrigações de uso.

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

O perfil simple é a resposta padrão; all acrescenta campos detalhados, técnicos ou de compatibilidade. Use o parâmetro fields para solicitar uma lista explícita.

CampoPerfisSignificado
idsimple / allIdentificador numérico interno do registro exportado nesta instalação OpenDataBio.
uuidsimple / allUUID estável do registro exportado.
locationIDsimple / allColuna Darwin Core: identificador estável do registro de localidade, formatado pelo OpenDataBio como odb:{installation}:location:{uuid}.
basisOfRecordsimple / allColuna Darwin Core: valor basisOfRecord indicando o tipo geral de registro biológico.
locationNamesimple / allRótulo de localidade compatível com Darwin Core usado pelo OpenDataBio para a localidade associada ao registro.
adm_levelsimple / allCódigo local OpenDataBio do nível administrativo de uma localidade.
country_adm_levelsimple / allCódigo local OpenDataBio do nível administrativo que representa o país.
xsimple / allCampo local OpenDataBio para geometria da localidade: dimensão X ou comprimento de uma parcela/transecto no sistema de coordenadas local da localidade.
ysimple / allCampo local OpenDataBio para geometria da localidade: dimensão Y de uma parcela ou valor de largura/buffer de um transecto no sistema de coordenadas local da localidade.
startxsimple / allCoordenada X inicial local OpenDataBio de uma parcela, transecto ou sistema de coordenadas local.
startysimple / allCoordenada Y inicial local OpenDataBio de uma parcela, transecto ou sistema de coordenadas local.
distance_to_searchsimple / allDistância local OpenDataBio, geralmente em metros, entre uma localidade e a coordenada usada na busca.
parent_idsimple / allIdentificador numérico interno do registro pai em uma hierarquia.
parent_uuidsimple / allUUID estável do registro pai em uma hierarquia.
parentNamesimple / allNome local OpenDataBio da localidade pai.
higherGeographysimple / allColuna Darwin Core: contexto geográfico superior da localidade, como localidades parentais ou hierarquia administrativa.
footprintWKTsimple / allColuna Darwin Core: geometria da localidade em formato WKT, quando disponível.
locationRemarkssimple / allColuna Darwin Core: observações ou notas sobre a localidade.
decimalLatitudesimple / allColuna Darwin Core: latitude em graus decimais, quando coordenadas estão disponíveis para distribuição.
decimalLongitudesimple / allColuna Darwin Core: longitude em graus decimais, quando coordenadas estão disponíveis para distribuição.
georeferenceRemarkssimple / allColuna Darwin Core: notas descrevendo origem das coordenadas, incerteza ou detalhes de georreferenciamento.
geodeticDatumsimple / allColuna Darwin Core: datum espacial ou sistema de referência de coordenadas usado.

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

O perfil simple é a resposta padrão; all acrescenta campos detalhados, técnicos ou de compatibilidade. Use o parâmetro fields para solicitar uma lista explícita.

CampoPerfisSignificado
idsimple / allIdentificador numérico interno do registro exportado nesta instalação OpenDataBio.
uuidsimple / allUUID estável do registro exportado.
measurementIDsimple / allColuna Darwin Core: identificador estável do registro de medição, formatado pelo OpenDataBio como odb:{installation}:measurement:{uuid}.
dataset_idsimple / allIdentificador numérico interno do dataset que governa o registro exportado.
basisOfRecordsimple / allColuna Darwin Core: valor basisOfRecord indicando o tipo geral de registro biológico.
measured_typesimple / allTipo de modelo local OpenDataBio do objeto medido por um registro de medição.
measured_idsimple / allIdentificador numérico interno do objeto medido por um registro de medição.
measured_uuidsimple / allUUID estável do objeto medido por um registro de medição, quando o objeto possui UUID.
trait_idsimple / allIdentificador numérico interno do trait ligado.
trait_uuidsimple / allUUID estável do trait ligado.
measurementTypesimple / allColuna Darwin Core MeasurementOrFact: nome de exportação do trait ou tipo de medição representado.
measurementValuesimple / allColuna Darwin Core MeasurementOrFact: valor registrado da medição.
measurementUnitsimple / allColuna Darwin Core MeasurementOrFact: unidade associada ao valor da medição.
measurementDeterminedBysimple / allColuna Darwin Core MeasurementOrFact: pessoa ou pessoas que determinaram ou registraram a medição.
measurementDeterminedDatesimple / allColuna Darwin Core MeasurementOrFact: data em que a medição foi determinada ou registrada.
scientificNamesimple / allColuna taxonômica Darwin Core: nome científico associado ao registro no momento da exportação.
familysimple / allColuna taxonômica Darwin Core: família associada ao táxon exportado ou organismo identificado.
datasetIDsimple / allColuna Darwin Core: identificador estável do dataset que governa o registro, formatado pelo OpenDataBio como odb:{installation}:dataset:{uuid}; inclui o UUID do dataset e os prefixos da instalação.
datasetNamesimple / allColuna Darwin Core: nome ou título do dataset que governa o registro exportado.
sourceCitationsimple / allCitação da fonte da qual o registro ou medição foi derivado.
accessRightssimple / allColuna Darwin Core: informação legível sobre permissões, restrições e condições de uso do registro, derivada da licença e da política de dados do dataset que governa o registro.
policyCodesimple / allCódigo compacto da política derivado da licença do dataset e das obrigações de uso.
dataset_uuidallUUID estável do dataset que governa o registro exportado.
measurementRemarksallColuna Darwin Core MeasurementOrFact: notas associadas à medição.
resourceRelationshipallColuna Darwin Core ResourceRelationship: tipo de relação entre o registro exportado e o recurso ao qual ele está ligado.
resourceRelationshipIDallColuna Darwin Core de relação: identificador estável do recurso OpenDataBio relacionado, formatado como odb:{installation}:{type}:{uuid} quando o objeto relacionado possui identificador estável.
resourceRelationshipNameallColuna compatível com Darwin Core ResourceRelationship: nome legível do recurso relacionado.
relationshipOfResourceallValor Darwin Core relationshipOfResource descrevendo como o recurso está relacionado.
measurementMethodallColuna Darwin Core MeasurementOrFact: método ou protocolo usado para obter a medição.
bibreference_idallIdentificador numérico interno da referência bibliográfica ligada.
bibreference_uuidallUUID estável da referência bibliográfica ligada.
measurementLocationIdallIdentificador numérico interno da localidade associada à medição.
measurementLocationUuidallUUID estável da localidade associada à medição.
measurementParentIdallIdentificador numérico interno da medição pai quando esta medição é aninhada.
measurementParentUuidallUUID estável da medição pai quando esta medição é aninhada.
decimalLatitudeallColuna Darwin Core: latitude em graus decimais, quando coordenadas estão disponíveis para distribuição.
decimalLongitudeallColuna Darwin Core: longitude em graus decimais, quando coordenadas estão disponíveis para distribuição.
policyUrlallURL onde a política completa do dataset ou versão pode ser consultada.
policySummaryallResumo curto, em linguagem simples, das permissões e obrigações de uso.

Exemplo de resposta

{
    "meta": {
        "odb_version": "0.10.0-alpha1",
        "api_version": "v0",
        "server": "http://localhost/opendatabio"
    },
    "data": [
        {
            "id": 853443,
            "basisOfRecord": "MeasurementsOrFact",
            "measured_type": "App\\Models\\Voucher",
            "measured_id": 1519,
            "measurementType": "HasSilica",
            "measurementValue": "Sim",
            "measurementUnit": null,
            "measurementDeterminedDate": "2014-09-24",
            "measurementDeterminedBy": "Equipe FITO",
            "measurementRemarks": null,
            "resourceRelationship": null,
            "resourceRelationshipID": "3304.8846.Equipe-FITO.PDBFF.PDBFF005425",
            "relationshipOfResource": "measurement of",
            "scientificName": "Pouteria fimbriata",
            "family": "Sapotaceae",
            "datasetName": "SILICOTECA",
            "measurementMethod": "Name: Has sílica-gel sample for DNA extraction | Definition:Has a tissue preserved in sílica-gel for DNA extractions. | Categories: CategoryName: Yes | Definition:Has an associated sample in sílica-gel.",
            "sourceCitation": null,
            "measurementLocationId": 29639,
            "measurementParentId": null,
            "decimalLatitude": -2.36495453,
            "decimalLongitude": -59.97365135
        }
    ]
}

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

O perfil simple é a resposta padrão; all acrescenta campos detalhados, técnicos ou de compatibilidade. Use o parâmetro fields para solicitar uma lista explícita.

CampoPerfisSignificado
idsimple / allIdentificador numérico interno do registro exportado nesta instalação OpenDataBio.
uuidsimple / allUUID estável do registro exportado.
model_typesimple / allClasse de modelo local OpenDataBio do objeto ligado a um registro de mídia.
model_idsimple / allIdentificador numérico interno do objeto OpenDataBio ligado a um registro de mídia.
model_uuidsimple / allUUID estável do objeto OpenDataBio ligado a um registro de mídia.
dataset_idsimple / allIdentificador numérico interno do dataset que governa o registro exportado.
dataset_uuidsimple / allUUID estável do dataset que governa o registro exportado.
project_idsimple / allIdentificador numérico interno do projeto ligado ao registro ou dataset.
project_uuidsimple / allUUID estável do projeto ligado ao registro ou dataset.
basisOfRecordsimple / allColuna Darwin Core: valor basisOfRecord indicando o tipo geral de registro biológico.
recordedBysimple / allColuna Darwin Core: coletores ou observadores associados ao registro.
eventDatesimple / allColuna Darwin Core: data ou intervalo em que ocorreu o evento de coleta, observação, captura da mídia ou ocorrência.
dwcTypesimple / allValor Darwin Core / Dublin Core de tipo da mídia ou recurso ligado.
resourceRelationshipsimple / allColuna Darwin Core ResourceRelationship: tipo de relação entre o registro exportado e o recurso ao qual ele está ligado.
resourceRelationshipIDsimple / allColuna Darwin Core de relação: identificador estável do recurso OpenDataBio relacionado, formatado como odb:{installation}:{type}:{uuid} quando o objeto relacionado possui identificador estável.
resourceRelationshipNamesimple / allColuna compatível com Darwin Core ResourceRelationship: nome legível do recurso relacionado.
relationshipOfResourcesimple / allValor Darwin Core relationshipOfResource descrevendo como o recurso está relacionado.
scientificNamesimple / allColuna taxonômica Darwin Core: nome científico associado ao registro no momento da exportação.
familysimple / allColuna taxonômica Darwin Core: família associada ao táxon exportado ou organismo identificado.
datasetIDsimple / allColuna Darwin Core: identificador estável do dataset que governa o registro, formatado pelo OpenDataBio como odb:{installation}:dataset:{uuid}; inclui o UUID do dataset e os prefixos da instalação.
datasetNamesimple / allColuna Darwin Core: nome ou título do dataset que governa o registro exportado.
projectNamesimple / allNome ou sigla do projeto ligado ao registro ou dataset.
taggedWithsimple / allTags ou palavras-chave associadas ao registro.
accessRightssimple / allColuna Darwin Core: informação legível sobre permissões, restrições e condições de uso do registro, derivada da licença e da política de dados do dataset que governa o registro.
policyCodesimple / allCódigo compacto da política derivado da licença do dataset e das obrigações de uso.
licensesimple / allLicença atribuída ao arquivo de mídia ou recurso de dataset.
file_namesimple / allNome do arquivo armazenado para uma mídia ou arquivo de dataset para download.
file_urlsimple / allURL pública para recuperar o arquivo de mídia ou arquivo de download.
citationsimple / allCitação legível associada ao registro ou arquivo de mídia.
recordedDateallColuna legada OpenDataBio equivalente a Darwin Core eventDate. Mantida em exportações all por compatibilidade; prefira eventDate para interoperabilidade.
policyUrlallURL onde a política completa do dataset ou versão pode ser consultada.
policySummaryallResumo curto, em linguagem simples, das permissões e obrigações de uso.
bibliographicCitationallColuna Darwin Core / Dublin Core: citação bibliográfica formatada associada ao registro.
bibtexallRepresentação BibTeX da referência bibliográfica ou citação de mídia.
userNameallNome do usuário OpenDataBio associado à ação no registro.
created_atallData e hora em que o registro foi criado no OpenDataBio.

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

O perfil simple é a resposta padrão; all acrescenta campos detalhados, técnicos ou de compatibilidade. Use o parâmetro fields para solicitar uma lista explícita.

CampoPerfisSignificado
idsimple / allIdentificador numérico interno do registro exportado nesta instalação OpenDataBio.
uuidsimple / allUUID estável do registro exportado.
full_namesimple / allNome completo local OpenDataBio de uma pessoa.
abbreviationsimple / allAbreviação local OpenDataBio de uma pessoa ou biocoleção.
emailAddresssimple / allE-mail local OpenDataBio de pessoa quando está disponível para exportação.
institutionsimple / allInstituição local OpenDataBio associada a uma pessoa.
orcidsimple / allIdentificador ORCID associado a uma pessoa.
notessimple / allNotas locais OpenDataBio associadas ao recurso exportado.

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

O perfil simple é a resposta padrão; all acrescenta campos detalhados, técnicos ou de compatibilidade. Use o parâmetro fields para solicitar uma lista explícita.

CampoPerfisSignificado
idsimple / allIdentificador numérico interno do registro exportado nesta instalação OpenDataBio.
uuidsimple / allUUID estável do registro exportado.
acronymsimple / allSigla local OpenDataBio de um projeto ou biocoleção.
namesimple / allNome local OpenDataBio do recurso exportado.
descriptionsimple / allTexto descritivo local OpenDataBio do recurso exportado.
pagesallMetadados locais OpenDataBio de páginas do projeto.
urlsallLista local OpenDataBio de URLs associadas a um projeto.
created_atallData e hora em que o registro foi criado no OpenDataBio.
updated_atallData e hora da última atualização do registro no OpenDataBio.

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

O perfil simple é a resposta padrão; all acrescenta campos detalhados, técnicos ou de compatibilidade. Use o parâmetro fields para solicitar uma lista explícita.

CampoPerfisSignificado
basisOfRecordsimple / allColuna Darwin Core: valor basisOfRecord indicando o tipo geral de registro biológico.
idsimple / allIdentificador numérico interno do registro exportado nesta instalação OpenDataBio.
uuidsimple / allUUID estável do registro exportado.
scientificNameIDsimple / allColuna taxonômica Darwin Core: identificador estável do registro de nome taxonômico, formatado pelo OpenDataBio como odb:{installation}:taxon:{uuid}.
scientificNamesimple / allColuna taxonômica Darwin Core: nome científico associado ao registro no momento da exportação.
taxonRanksimple / allColuna taxonômica Darwin Core: nível taxonômico do nome científico.
scientificNameAuthorshipsimple / allColuna taxonômica Darwin Core: texto de autoria associado ao nome científico.
namePublishedInsimple / allColuna taxonômica Darwin Core: referência bibliográfica na qual o nome taxonômico foi publicado.
parentNameUsageIDsimple / allColuna taxonômica Darwin Core: identificador estável do táxon pai, formatado pelo OpenDataBio como odb:{installation}:taxon:{uuid}.
parentNameUsagesimple / allColuna taxonômica Darwin Core: nome do táxon pai na hierarquia taxonômica.
familysimple / allColuna taxonômica Darwin Core: família associada ao táxon exportado ou organismo identificado.
higherClassificationsimple / allColuna taxonômica Darwin Core: caminho de classificação taxonômica superior do táxon.
taxonRemarkssimple / allColuna taxonômica Darwin Core: observações sobre o táxon.
taxonomicStatussimple / allColuna taxonômica Darwin Core: status taxonômico do nome, como nome aceito ou sinônimo.
acceptedNameUsagesimple / allColuna taxonômica Darwin Core: nome científico aceito quando o nome exportado não é aceito.
acceptedNameUsageIDsimple / allColuna taxonômica Darwin Core: identificador estável do nome taxonômico aceito, formatado pelo OpenDataBio como odb:{installation}:taxon:{uuid}.
author_uuidallUUID estável da pessoa ligada como autora de um nome taxonômico não publicado.
bibreference_uuidallUUID estável da referência bibliográfica ligada.
parent_idallIdentificador numérico interno do registro pai em uma hierarquia.
parent_uuidallUUID estável do registro pai em uma hierarquia.
senior_idallIdentificador numérico interno do nome taxonômico aceito ou sênior.
externalKeysallIdentificadores de bases externas ligados a um nome taxonômico no OpenDataBio.

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 idioma. Para POST vernaculars, idiomas cadastrados são aceitos; idiomas ausentes são criados a partir de config/languagesISO6393.php apenas quando o valor informado corresponder a código ISO639-3 ou nome configurado, com is_locale=0.en ou 1 ou english ou spa
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

O perfil simple é a resposta padrão; all acrescenta campos detalhados, técnicos ou de compatibilidade. Use o parâmetro fields para solicitar uma lista explícita.

CampoPerfisSignificado
idsimple / allIdentificador numérico interno do registro exportado nesta instalação OpenDataBio.
uuidsimple / allUUID estável do registro exportado.
parent_idsimple / allIdentificador numérico interno do registro pai em uma hierarquia.
parent_uuidsimple / allUUID estável do registro pai em uma hierarquia.
typesimple / allCódigo ou rótulo local OpenDataBio do tipo do recurso exportado.
typenamesimple / allNome legível local OpenDataBio de um tipo de trait.
export_namesimple / allNome de exportação estável local OpenDataBio de um trait, usado como chave pública em medições.
unitsimpleUnidade de medição local OpenDataBio configurada para um trait.
range_minsimple / allValor mínimo válido local OpenDataBio configurado para um trait quantitativo.
range_maxsimple / allValor máximo válido local OpenDataBio configurado para um trait quantitativo.
link_typesimple / allTipo de objeto alvo local OpenDataBio permitido para um trait do tipo link.
value_lengthsimple / allNúmero local OpenDataBio de valores esperados para um trait espectral.
namesimple / allNome local OpenDataBio do recurso exportado.
descriptionsimple / allTexto descritivo local OpenDataBio do recurso exportado.
objectssimple / allLista local OpenDataBio de tipos de objetos aos quais um trait pode se aplicar.
measurementTypesimple / allColuna Darwin Core MeasurementOrFact: nome de exportação do trait ou tipo de medição representado.
categoriessimple / allLista local OpenDataBio de categorias de trait, incluindo rótulos e descrições quando disponíveis.
bibreference_idallIdentificador numérico interno da referência bibliográfica ligada.
bibreference_uuidallUUID estável da referência bibliográfica ligada.
measurementUnitallColuna Darwin Core MeasurementOrFact: unidade associada ao valor da medição.
measurementMethodallColuna Darwin Core MeasurementOrFact: método ou protocolo usado para obter a medição.
MeasurementTypeBibkeysallLista local OpenDataBio de bibkeys que sustentam o tipo de medição do trait.
TaggedWithallLista local OpenDataBio de tags associadas a um trait.

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

O perfil simple é a resposta padrão; all acrescenta campos detalhados, técnicos ou de compatibilidade. Use o parâmetro fields para solicitar uma lista explícita.

CampoPerfisSignificado
idsimple / allIdentificador numérico interno do registro exportado nesta instalação OpenDataBio.
uuidsimple / allUUID estável do registro exportado.
namesimple / allNome local OpenDataBio do recurso exportado.
languageNamesimple / allNome do idioma local OpenDataBio associado a um nome vernacular.
notessimple / allNotas locais OpenDataBio associadas ao recurso exportado.
locationsListsimple / allLista legível local OpenDataBio de localidades ligadas ao registro.
taxonsListsimple / allLista legível local OpenDataBio de táxons ligados ao registro.
individualsListsimple / allLista legível local OpenDataBio de indivíduos ligados ao registro.
citationsArraysimple / allLista estruturada local OpenDataBio de citações ligadas a um nome vernacular.
languageCodeallCódigo de idioma local OpenDataBio associado a um nome vernacular.
taxonsListArrayallArray estruturado local OpenDataBio de táxons ligados ao registro.
individualsListArrayallArray estruturado local OpenDataBio de indivíduos ligados ao registro.
locationsListArrayallArray estruturado local OpenDataBio de localidades ligadas ao registro.
variantsListallLista legível local OpenDataBio de variantes vernaculares ligadas ao registro.
variantsListArrayallArray estruturado local OpenDataBio de variantes vernaculares ligadas ao registro.
createdByallUsuário ou pessoa local OpenDataBio que criou o registro.
created_atallData e hora em que o registro foi criado no OpenDataBio.
updated_atallData e hora da última atualização do registro no OpenDataBio.

Exemplo de resposta

{
    "meta": {
        "odb_version": "0.10.0-alpha1",
        "api_version": "v0",
        "server": "http://localhost/opendatabio"
    },
    "data": []
}

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

O perfil simple é a resposta padrão; all acrescenta campos detalhados, técnicos ou de compatibilidade. Use o parâmetro fields para solicitar uma lista explícita.

CampoPerfisSignificado
idsimple / allIdentificador numérico interno do registro exportado nesta instalação OpenDataBio.
uuidsimple / allUUID estável do registro exportado.
individual_uuidsimple / allUUID estável do indivíduo ou organismo ligado.
basisOfRecordsimple / allColuna Darwin Core: valor basisOfRecord indicando o tipo geral de registro biológico.
occurrenceIDsimple / allColuna Darwin Core: identificador estável do registro de ocorrência biológica. Uma ocorrência representa a presença/registro de um organismo ou táxon em uma localidade.
organismIDsimple / allColuna Darwin Core: identificador estável do organismo/indivíduo, formatado pelo OpenDataBio como odb:{installation}:individual:{uuid}.
organismNamesimple / allColuna Darwin Core: rótulo legível do organismo ou registro de indivíduo.
materialEntityIDsimple / allColuna Darwin Core: identificador estável da entidade material física. Nas exportações de vouchers do OpenDataBio, é o identificador estável do voucher, formatado como odb:{installation}:voucher:{uuid}.
collectionCodesimple / allColuna Darwin Core: código, sigla ou nome que identifica a biocoleção.
catalogNumbersimple / allColuna Darwin Core: número de catálogo ou número de acesso do voucher na biocoleção.
typeStatussimple / allColuna Darwin Core: status nomenclatural de tipo de um voucher.
recordedByMainsimple / allColetor ou observador principal responsável pelo registro.
recordNumbersimple / allColuna Darwin Core: número de coleta ou observação.
eventDatesimple / allColuna Darwin Core: data ou intervalo em que ocorreu o evento de coleta, observação, captura da mídia ou ocorrência.
recordedBysimple / allColuna Darwin Core: coletores ou observadores associados ao registro.
scientificNamesimple / allColuna taxonômica Darwin Core: nome científico associado ao registro no momento da exportação.
familysimple / allColuna taxonômica Darwin Core: família associada ao táxon exportado ou organismo identificado.
identificationQualifiersimple / allColuna Darwin Core: qualificador que expressa incerteza ou condição da identificação.
identifiedBysimple / allColuna Darwin Core: pessoa ou pessoas responsáveis pela identificação taxonômica.
dateIdentifiedsimple / allColuna Darwin Core: data em que a identificação taxonômica foi feita.
identificationRemarkssimple / allColuna Darwin Core: notas associadas à identificação taxonômica.
location_idsimple / allIdentificador numérico interno da localidade ligada.
location_uuidsimple / allUUID estável da localidade ligada.
locationNamesimple / allRótulo de localidade compatível com Darwin Core usado pelo OpenDataBio para a localidade associada ao registro.
higherGeographysimple / allColuna Darwin Core: contexto geográfico superior da localidade, como localidades parentais ou hierarquia administrativa.
decimalLatitudesimple / allColuna Darwin Core: latitude em graus decimais, quando coordenadas estão disponíveis para distribuição.
decimalLongitudesimple / allColuna Darwin Core: longitude em graus decimais, quando coordenadas estão disponíveis para distribuição.
occurrenceRemarkssimple / allColuna Darwin Core: observações sobre a ocorrência.
datasetIDsimple / allColuna Darwin Core: identificador estável do dataset que governa o registro, formatado pelo OpenDataBio como odb:{installation}:dataset:{uuid}; inclui o UUID do dataset e os prefixos da instalação.
datasetNamesimple / allColuna Darwin Core: nome ou título do dataset que governa o registro exportado.
accessRightssimple / allColuna Darwin Core: informação legível sobre permissões, restrições e condições de uso do registro, derivada da licença e da política de dados do dataset que governa o registro.
policyCodesimple / allCódigo compacto da política derivado da licença do dataset e das obrigações de uso.
dataset_idallIdentificador numérico interno do dataset que governa o registro exportado.
individual_idallIdentificador numérico interno do indivíduo ou organismo ligado.
recordedDateallColuna legada OpenDataBio equivalente a Darwin Core eventDate. Mantida em exportações all por compatibilidade; prefira eventDate para interoperabilidade.
scientificNameAuthorshipallColuna taxonômica Darwin Core: texto de autoria associado ao nome científico.
taxon_idallIdentificador numérico interno do nome taxonômico ligado.
taxon_uuidallUUID estável do nome taxonômico ligado.
identification_idallIdentificador numérico interno da identificação taxonômica ligada ao registro.
identification_uuidallUUID estável da identificação taxonômica ligada ao registro.
taxonPublishedStatusallStatus de publicação do nome taxonômico usado na identificação.
genusallColuna taxonômica Darwin Core: gênero associado ao táxon exportado ou organismo identificado.
georeferenceRemarksallColuna Darwin Core: notas descrevendo origem das coordenadas, incerteza ou detalhes de georreferenciamento.
relatedLocationsallOutras localidades relacionadas ao registro, como parcelas, transectos ou localidades de ocorrência ligadas.
policyUrlallURL onde a política completa do dataset ou versão pode ser consultada.
policySummaryallResumo curto, em linguagem simples, das permissões e obrigações de uso.

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

O perfil simple é a resposta padrão; all acrescenta campos detalhados, técnicos ou de compatibilidade. Use o parâmetro fields para solicitar uma lista explícita.

CampoPerfisSignificado
idsimple / allIdentificador numérico interno do registro exportado nesta instalação OpenDataBio.
dispatchersimple / allClasse do dispatcher ou tipo de job local OpenDataBio.
statussimple / allStatus local OpenDataBio de um job em segundo plano ou recurso exportado.
percentagesimple / allPercentual de progresso local OpenDataBio de um job em segundo plano.
created_atsimple / allData e hora em que o registro foi criado no OpenDataBio.
affected_ids_countsimple / allContagem local OpenDataBio de registros afetados por um job em segundo plano.
affected_modelsimple / allClasse de modelo ou nome do modelo local OpenDataBio afetado por um job em segundo plano.
updated_atallData e hora da última atualização do registro no OpenDataBio.
affected_idsallLista local OpenDataBio de ids de registros afetados por um job em segundo plano.
logallTexto de log local OpenDataBio produzido por um job em segundo plano.

Exemplo de resposta

{
    "message": "Unauthenticated",
    "0": 401
}

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 idioma. Para POST vernaculars, idiomas cadastrados são aceitos; idiomas ausentes são criados a partir de config/languagesISO6393.php apenas quando o valor informado corresponder a código ISO639-3 ou nome configurado, com is_locale=0.en ou 1 ou english ou spa
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

O perfil simple é a resposta padrão; all acrescenta campos detalhados, técnicos ou de compatibilidade. Use o parâmetro fields para solicitar uma lista explícita.

CampoPerfisSignificado
idsimple / allIdentificador numérico interno do registro exportado nesta instalação OpenDataBio.
log_namesimple / allNome local OpenDataBio do log de atividade.
descriptionsimple / allTexto descritivo local OpenDataBio do recurso exportado.
subject_typesimple / allClasse de modelo local OpenDataBio do objeto registrado em uma entrada de log de atividade.
subject_namesimple / allNome legível local OpenDataBio do objeto registrado em uma entrada de log de atividade.
subject_idsimple / allIdentificador numérico interno do objeto registrado em uma entrada de log de atividade.
modified_bysimple / allUsuário local OpenDataBio que modificou o objeto do log de atividade.
propertiessimple / allPropriedades estruturadas locais OpenDataBio do log de atividade, geralmente codificadas como JSON.
created_atsimple / allData e hora em que o registro foi criado no OpenDataBio.
updated_atsimple / allData e hora da última atualização do registro no OpenDataBio.

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 idioma. Para POST vernaculars, idiomas cadastrados são aceitos; idiomas ausentes são criados a partir de config/languagesISO6393.php apenas quando o valor informado corresponder a código ISO639-3 ou nome configurado, com is_locale=0.en ou 1 ou english ou spa
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

O perfil simple é a resposta padrão; all acrescenta campos detalhados, técnicos ou de compatibilidade. Use o parâmetro fields para solicitar uma lista explícita.

CampoPerfisSignificado
idsimple / allIdentificador numérico interno do registro exportado nesta instalação OpenDataBio.
namesimple / allNome local OpenDataBio do recurso exportado.
descriptionsimple / allTexto descritivo local OpenDataBio do recurso exportado.
countsallContagens resumidas locais OpenDataBio associadas a uma tag.

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
            }
        }
    ]
}

brahms (GET)

Exportacao de individuos no formato BRAHMS/INPA (GET lista, exportacao em job com save_job).

ParâmetroObrigatórioDescriçãoExemplo
idNãoId unico ou lista separada por virgula para filtrar/selecionar registros.1,2,3
brahms_levelNãoNivel da exportacao BRAHMS. Use individual para uma linha por individuo, ou voucher para uma linha por voucher ligado aos individuos encontrados.individual ou voucher
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
habitattxt_traitsNãoLista de ids/export_name de traits de medicao ou chaves JSON de notas para o habitattxt do BRAHMS. Chaves JSON sao buscadas nas notas do individuo e da individual-location; medicoes sao buscadas no individuo e na localidade atual. Use all ou none.all ou soil_type,canopy_opening ou none
habitattxt_traits_headerNãoBooleano, ou lista de booleanos separada por virgula, controlando se export_name do trait ou chave JSON entra como prefixo no habitattxt.1 ou 1,0,1
include_taxon_vernacularsNãoQuando 1, o vernacular do BRAHMS tambem inclui nomes ligados ao taxon do individuo.0
include_vernacularsNãoQuando 1, inclui nomes vernaculares na saida BRAHMS.1
include_voucher_individualsNãoPara exportacoes BRAHMS no nivel individual com filtro de dataset, inclui individuos fora do dataset quando eles possuem vouchers no dataset solicitado.1
job_idNãoId do job para reutilizar affected_ids ou filtrar resultados.1024
langNãoCodigo/nome do idioma. Para BRAHMS, deve corresponder a um registro de languages com is_locale=1 e e usado para nomes de categorias de traits e cores; nao afeta nomes vernaculares.pt-br
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
locnotes_traitsNãoLista de ids/export_name de traits de medicao ou chaves JSON de notas para o locnotes do BRAHMS. Chaves JSON sao buscadas nas notas do individuo e da individual-location; medicoes sao buscadas no individuo e na localidade atual. Use all ou none. O padrao none mantem locnotes apenas com notas da individual-location.none ou trail_notes,soil_type
locnotes_traits_headerNãoBooleano, ou lista de booleanos separada por virgula, controlando se export_name do trait ou chave JSON entra como prefixo no locnotes.1 ou 1,0,1
measurement_datasetNãoLista de ids/nomes de datasets usada para limitar as medicoes resumidas nas descricoes BRAHMS.Flora-INPA
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.
plantdesc_traitsNãoLista de ids/export_name de traits de medicao ou chaves JSON de notas do individuo para o plantdesc do BRAHMS. Use all ou none.all ou leaf_color,dbh ou none
plantdesc_traits_headerNãoBooleano, ou lista de booleanos separada por virgula, controlando se export_name do trait ou chave JSON entra como prefixo no plantdesc.1 ou 1,0,1
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
traitNãoId ou export_name do trait para filtro.DBH
vernacularNãoId ou nome de vernacular para filtrar individuals.castanha|12

Campos retornados

O perfil simple é a resposta padrão; all acrescenta campos detalhados, técnicos ou de compatibilidade. Use o parâmetro fields para solicitar uma lista explícita.

CampoPerfisSignificado
odbUuidsimple / allColuna de exportação BRAHMS/INPA: UUID OpenDataBio do registro fonte exportado.
collectorsimple / allColuna de exportação BRAHMS/INPA para nome ou abreviação do coletor principal.
numbersimple / allNúmero de registro, coleta ou BRAHMS; o significado exato depende do endpoint.
addcollsimple / allColuna de exportação BRAHMS/INPA para coletores adicionais.
collddsimple / allColuna de exportação BRAHMS/INPA para dia da coleta.
collmmsimple / allColuna de exportação BRAHMS/INPA para mês da coleta.
collyysimple / allColuna de exportação BRAHMS/INPA para ano da coleta.
familysimple / allColuna taxonômica Darwin Core: família associada ao táxon exportado ou organismo identificado.
genussimple / allColuna taxonômica Darwin Core: gênero associado ao táxon exportado ou organismo identificado.
sp1simple / allColuna de exportação BRAHMS/INPA para o primeiro epíteto específico.
sp2simple / allColuna de exportação BRAHMS/INPA para o segundo epíteto ou nome infraespecífico.
detbysimple / allColuna de exportação BRAHMS/INPA para a pessoa que identificou o espécime ou indivíduo.
countrysimple / allNome ou código do país associado a uma localidade, coleção ou linha de exportação BRAHMS.
majorareasimple / allColuna de exportação BRAHMS/INPA para área geográfica principal.
minorareasimple / allColuna de exportação BRAHMS/INPA para área geográfica secundária.
gazetteersimple / allColuna de exportação BRAHMS/INPA para gazetteer ou localidade nomeada.
locnotessimple / allColuna de exportação BRAHMS/INPA para notas da localidade, localidades relacionadas e informação de posição local.
habitattxtsimple / allColuna de exportação BRAHMS/INPA para texto de habitat, geralmente derivado de medições da localidade atual quando disponíveis.
latsimple / allColuna de exportação BRAHMS/INPA: valor de latitude formatado para a tabela de intercâmbio BRAHMS.
NSsimple / allColuna de exportação BRAHMS/INPA indicando se a latitude está ao norte ou ao sul.
longsimple / allColuna de exportação BRAHMS/INPA: valor de longitude formatado para a tabela de intercâmbio BRAHMS.
EWsimple / allColuna de exportação BRAHMS/INPA indicando se a longitude está a leste ou oeste.
llunitsimple / allColuna de exportação BRAHMS/INPA que descreve a unidade ou formato de latitude/longitude.
altsimple / allColuna de exportação BRAHMS/INPA para elevação ou altitude.
plantdescsimple / allColuna de exportação BRAHMS/INPA para descrição da planta, derivada de medições e notas do indivíduo ou voucher.
vernacularsimple / allColuna de exportação BRAHMS/INPA para nomes vernaculares.
projectsimple / allColuna de exportação BRAHMS/INPA para nome, sigla ou código do projeto.
campoallColuna de exportação BRAHMS/INPA usada por fluxos locais para identificar o campo ou contexto fonte.
accessionallColuna de exportação BRAHMS/INPA para valor de acesso ou accession de coleção.
prefixallColuna de exportação BRAHMS/INPA para prefixo do número de coleta.
suffixallColuna de exportação BRAHMS/INPA para sufixo do número de coleta.
initialallColuna de exportação BRAHMS/INPA para iniciais do coletor ou campo local de iniciais.
detstatusallColuna de exportação BRAHMS/INPA para status da determinação.
rank1allColuna de exportação BRAHMS/INPA para categoria infraespecífica.
detddallColuna de exportação BRAHMS/INPA para dia da identificação.
detmmallColuna de exportação BRAHMS/INPA para mês da identificação.
detyyallColuna de exportação BRAHMS/INPA para ano da identificação.
alt1allColuna de exportação BRAHMS/INPA para valor secundário de elevação ou altitude.
dupsallColuna de exportação BRAHMS/INPA para informação de duplicatas de espécimes.

identification-histories (GET)

Histórico de identificações (GET lista, POST cria linhas manuais de histórico).

ParâmetroObrigatórioDescriçãoExemplo
idNãoId unico ou lista separada por virgula para filtrar/selecionar registros.1,2,3
biocollectionNãoId, nome ou sigla da biocoleção.INPA
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
identification_idNãoId do registro de identificação. Para POST identification-histories é opcional; quando informado, deve pertencer ao individual_id. Quando omitido, a API deriva a identificação a partir de individual_id.123
individualNãoId, uuid ou organismID do indivíduo.4521 ou 2ff0e884-3d33
individual_idNãoIds de indivíduos para ocorrências.12,55,90
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
personNãoId/abreviação/nome/email de pessoa (aceita lista com | ou ;).Silva, J.B.|Costa, M.
save_jobNãoSe 1, salva a consulta como job para baixar depois via userjobs + get_file = 11
sourceNãoRótulo de origem para registros gerados ou importados.api
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

O perfil simple é a resposta padrão; all acrescenta campos detalhados, técnicos ou de compatibilidade. Use o parâmetro fields para solicitar uma lista explícita.

CampoPerfisSignificado
idsimple / allIdentificador numérico interno do registro exportado nesta instalação OpenDataBio.
identification_idsimple / allIdentificador numérico interno da identificação taxonômica ligada ao registro.
identification_uuidsimple / allUUID estável da identificação taxonômica ligada ao registro.
individual_idsimple / allIdentificador numérico interno do indivíduo ou organismo ligado.
individual_uuidsimple / allUUID estável do indivíduo ou organismo ligado.
organismIDsimple / allColuna Darwin Core: identificador estável do organismo/indivíduo, formatado pelo OpenDataBio como odb:{installation}:individual:{uuid}.
organismNamesimple / allColuna Darwin Core: rótulo legível do organismo ou registro de indivíduo.
taxon_idsimple / allIdentificador numérico interno do nome taxonômico ligado.
taxon_uuidsimple / allUUID estável do nome taxonômico ligado.
scientificNamesimple / allColuna taxonômica Darwin Core: nome científico associado ao registro no momento da exportação.
familysimple / allColuna taxonômica Darwin Core: família associada ao táxon exportado ou organismo identificado.
identificationQualifiersimple / allColuna Darwin Core: qualificador que expressa incerteza ou condição da identificação.
identifiedBysimple / allColuna Darwin Core: pessoa ou pessoas responsáveis pela identificação taxonômica.
dateIdentifiedsimple / allColuna Darwin Core: data em que a identificação taxonômica foi feita.
identificationBiocollectionsimple / allBiocoleção usada como referência para a identificação, quando aplicável.
identificationBiocollectionReferencesimple / allNúmero de catálogo ou referência na biocoleção usada para identificação.
identificationRemarkssimple / allColuna Darwin Core: notas associadas à identificação taxonômica.
replaced_atsimple / allData ou timestamp em que uma linha de histórico de identificação foi substituída.
replacedByNamesimple / allNome local OpenDataBio da identificação que substituiu esta linha de histórico de identificação.
sourcesimple / allRótulo local OpenDataBio da fonte do registro ou linha de histórico de identificação.
scientificNameAuthorshipallColuna taxonômica Darwin Core: texto de autoria associado ao nome científico.
taxonPublishedStatusallStatus de publicação do nome taxonômico usado na identificação.
genusallColuna taxonômica Darwin Core: gênero associado ao táxon exportado ou organismo identificado.
identifiersallLista local OpenDataBio de pessoas responsáveis por uma identificação taxonômica.
modifierallCódigo local OpenDataBio de qualificador/modificador de identificação armazenado em uma linha de histórico de identificação.
dateallData local OpenDataBio associada ao registro exportado; o evento exato depende do endpoint.
biocollection_idallIdentificador numérico interno da biocoleção ligada.
biocollection_uuidallUUID estável da biocoleção ligada.
replaced_byallIdentificador numérico interno da linha de histórico de identificação que substituiu esta linha.
source_idallIdentificador local OpenDataBio do registro fonte ou processo fonte.
source_payloadallConteúdo estruturado local OpenDataBio vindo do processo fonte, geralmente codificado como JSON.
created_atallData e hora em que o registro foi criado no OpenDataBio.
updated_atallData e hora da última atualização do registro no OpenDataBio.

Última modificação July 10, 2026: Updated docs to odb version 0.10.0-alpha2 (886b968)