This is the multi-page printable view of this section. Click here to print.

Return to the regular view of this page.

Serviços de API

Como obter, importar ou atualizar dados no OpenDataBio?

1: Referência rápida
2: Obter dados - GET
3: Inserir dados - POST
4: Atualizar dados - PUT

Cada instalação do OpenDataBio fornece um serviço de API, permitindo aos usuários OBTER, INSERIR, ATUALIZAR dados programaticamente. O serviço é de acesso aberto a dados públicos, e requer autenticação do usuário para INSERIR e ATUALIZAR dados, ou para OBTER dados de acesso restrito.

O pacote OpenDataBio é um cliente para esta API, permitindo a interação com o repositório de dados diretamente do R.

A API OpenDataBio permite a consulta ao banco de dados e a importação/edição de dados por meio de uma interface inspirada em REST.

Todas as solicitações e respostas da API são formatadas em JSON.

A interação com a API do OpenDataBio

Uma simples chamada para a API OpenDataBio possui quatro partes independentes:

[verbo HTTP] + URL base + endpoint + parâmetros de solicitação

HTTP-verbo - GET para exportações, POST para importações e PUT para atualizações.
URL-base - o URL usado para acessar seu servidor OpenDataBio + mais / api / v0. Por exemplo, http:// opendatabio.inpa.gov.br/api/v0
endpoint - representa o objeto ou coleção de objetos que você deseja acessar, por exemplo, para consultar nomes taxonômicos, o endpoint é “taxons”
parâmetros de solicitação - representam a filtragem e o processamento que devem ser feitos com os objetos e são representados na chamada da API após um ponto de interrogação. Por exemplo, para recuperar apenas nomes taxonômicos válidos finalize a solicitação com ?valid = 1.

A chamada API acima pode ser inserida em um navegador para OBTER dados de acesso público. Por exemplo, para obter a lista de táxons válidos de uma instalação do OpenDataBio, a solicitação da API poderia ser:


https://opendb.inpa.gov.br/api/v0/taxons?valid=1&limit=10

Quando usar o OpenDataBio R package essa mesma chamada seria algo como odb_get_taxons(list(valid=1,limit=10)).

A resposta será algo como:

{
  "meta":
  {
    "odb_version":"0.9.1-alpha1",
    "api_version":"v0",
    "server":"http://opendb.inpa.gov.br",
    "full_url":"https://opendb.inpa.gov.br/api/v0/taxons?valid=1&limit1&offset=100"},
    "data":
    [
      {
        "id":62,
        "parent_id":25,
        "author_id":null,
        "scientificName":"Laurales",
        "taxonRank":"Ordem",
        "scientificNameAuthorship":null,
        "namePublishedIn":"Juss. ex Bercht. & J. Presl. In: Prir. Rostlin: 235. (1820).",
        "parentName":"Magnoliidae",
        "family":null,
        "taxonRemarks":null,
        "taxonomicStatus":"accepted",
        "ScientificNameID":"http:\/\/tropicos.org\/Name\/43000015 | https:\/\/www.gbif.org\/species\/407",
        "basisOfRecord":"Taxon"
    }]}

Autenticação da API

Não é obrigatória para obter quaisquer dados de acesso público numa base de dados ODB, que por padrão inclui Localidades, Taxons, Referências Bibliográficas, Pessoas e Variáveis.
Autenticação é necessária para OBTER quaisquer dados que não sejam de acesso público e para INSERIR e ATUALIZAR dados.

A autenticação é feita usando um token API, que pode ser encontrado no seu perfil de usuário na interface do aplicativo. O token é atribuído a um único usuário do banco de dados e não deve ser compartilhado, exposto, enviado por e-mail ou armazenado em controles de versão.
Para autenticar na API OpenDataBio, use o token no cabeçalho “Authorization” da solicitação da API.

Os usuários terão acesso somente aos dados para os quais o usuário tem permissão e para quaisquer dados com acesso público na base de dados. O acesso à Medições, Indivíduos, Vouchers e Mídia depende das permissões compreendidas pelo token do usuário.

Versões da API

A API OpenDataBio segue seu próprio número de versão. Isso significa que o cliente pode esperar usar o mesmo código e obter as mesmas respostas, independentemente da versão do OpenDataBio que o servidor está executando. Todas as alterações feitas na mesma versão da API devem ser compatíveis com versões anteriores. Nosso controle de versão da API é controlado pelo URL, portanto, para solicitar uma versão específica da API, use o número da versão entre o URL base e o endpoint:

https://opendb.inpa.gov.br/api/v1/taxons

https://opendb.inpa.gov.br/api/v2/taxons

1 - Referência rápida

Lista dos EndPoints e dos Parâmetros para GET e POST!

Formato da API

base-URL + ‘/api/v0/’ + endpoint + ‘?’ + request-parameters

Exemplo para o Taxons endpoint

https://opendb.inpa.gov.br/api/v0/taxons?valid=1&level=210&limit=2&offset=10

OBTER DADOS - GET

Parâmetros GET compartilhados

Baixar muitos dados?

Os parâmetros limit e offset podem ser usados para dividir sua busca em partes.

Alternativamente, use a opção save_job=T e depois baixe os dados com o parametro get_file=T da API userjobs.

wildcards

Alguns parâmetros aceitam um asterisco como curinga, então api/v0/taxons?name=Euterpe retornará táxons com nome exatamente como “Euterpe”, enquanto api/v0/taxons?name=Eut* retornará nomes começando com “Eut”.

Quando múltiplos parâmetros são especificados eles são combinados com o operador AND. Não há opção de parâmetro OR nas suas buscas.

Parâmetro	Obrigatório	Descrição	Exemplo
`id`	Não	Id unico ou lista separada por virgula para filtrar/selecionar registros.	`1,2,3`
`limit`	Não	Quantidade maxima de registros retornados.	`100`
`offset`	Não	A posição inicial do conjunto de registros a ser exportado. Usado em conjunto com `limit` para limitar os resultados.	`10000`
`fields`	Não	Lista separada por vírgulas dos campos a serem incluídos na resposta ou uma palavra especial all/simple/raw, padrão: simple	`id,scientificName ou all`
`save_job`	Não	Se 1, salva a consulta como job para baixar depois via userjobs + get_file = 1	`1`

Parâmetros GET específicos

Endpoint	Descrição	Parâmetros
/	Testa seu acesso/token.	—
bibreferences	Referências bibliográficas (GET lista, POST cria).	id, bibkey, biocollection, dataset, fields, job_id, limit, offset, save_job, search, taxon, taxon_root
biocollections	Biocoleções (GET lista, POST cria).	id, acronym, fields, irn, job_id, limit, name, offset, save_job, search
datasets	Datasets e versões publicadas de datasets (GET lista, POST cria via job de importação).	id, bibreference, fields, has_versions, include_url, limit, list_versions, name, offset, project, save_job, search, summarize, tag, tagged_with, taxon, taxon_root, traits, version_id, version_uuid
individuals	Indivíduos (GET lista, POST cria, PUT atualiza).	id, dataset, date_max, date_min, fields, job_id, limit, location, location_root, odbrequest_id, offset, person, project, save_job, tag, taxon, taxon_root, trait, vernacular
individual-locations	Ocorrências para indivíduos com múltiplas localizações (GET lista, POST/PUT grava).	id, dataset, date_max, date_min, fields, individual, limit, location, location_root, offset, person, project, save_job, tag, taxon, taxon_root
languages	Lista idiomas disponíveis.	fields, limit, offset
locations	Localidades (GET lista, POST cria, PUT atualiza).	id, adm_level, dataset, fields, job_id, lat, limit, location_root, long, name, offset, parent_id, project, querytype, root, save_job, search, taxon, taxon_root, trait
measurements	Medições de traits (GET lista, POST cria via job de importação, PUT atualiza).	id, bibreference, dataset, date_max, date_min, fields, individual, job_id, limit, location, location_root, measured_id, measured_type, offset, person, project, save_job, taxon, taxon_root, trait, trait_type, voucher
media	Metadados de mídia (GET lista, POST cria, PUT atualiza).	id, dataset, fields, individual, job_id, limit, location, location_root, media_id, media_uuid, offset, person, project, save_job, tag, taxon, taxon_root, uuid, voucher
persons	Pessoas (GET lista, POST cria, PUT atualiza).	id, abbrev, email, fields, job_id, limit, name, offset, save_job, search
projects	Projetos (GET lista).	id, fields, job_id, limit, offset, save_job, search, tag
taxons	Nomes taxonômicos (GET lista, POST cria).	id, bibreference, biocollection, dataset, external, fields, job_id, level, limit, location_root, name, offset, person, project, root, save_job, taxon_root, trait, valid, vernacular
traits	Definições de traits (GET lista, POST cria).	id, bibreference, categories, dataset, fields, job_id, language, limit, name, object_type, offset, save_job, search, tag, taxon, taxon_root, trait, type
vernaculars	Nomes vernáculos (GET lista, POST cria).	id, fields, individual, job_id, limit, location, location_root, offset, save_job, taxon, taxon_root
vouchers	Vouchers de coleção (GET lista, POST cria, PUT atualiza).	id, bibreference, bibreference_id, biocollection, biocollection_id, collector, dataset, date_max, date_min, fields, individual, job_id, limit, location, location_root, main_collector, number, odbrequest_id, offset, person, project, save_job, taxon, taxon_root, trait, vernacular
userjobs	Jobs em background (importações/exportações) (GET lista).	id, fields, get_file, limit, offset, status
activities	Lista entradas do log de atividades.	id, description, fields, individual, language, limit, location, log_name, measurement, offset, save_job, subject, subject_id, taxon, taxon_root, voucher
tags	Tags/palavras-chave (GET lista).	id, dataset, fields, job_id, language, limit, name, offset, project, save_job, search, trait
brahms	Exportacao de individuos no formato BRAHMS/INPA (GET lista, exportacao em job com save_job).	id, brahms_level, dataset, date_max, date_min, fields, habitattxt_traits, habitattxt_traits_header, include_taxon_vernaculars, include_vernaculars, include_voucher_individuals, job_id, lang, limit, location, location_root, locnotes_traits, locnotes_traits_header, measurement_dataset, odbrequest_id, offset, person, plantdesc_traits, plantdesc_traits_header, project, save_job, tag, taxon, taxon_root, trait, vernacular
identification-histories	Histórico de identificações (GET lista, POST cria linhas manuais de histórico).	id, biocollection, date_max, date_min, fields, identification_id, individual, individual_id, job_id, limit, offset, person, save_job, source, taxon, taxon_root

Importar ou Validar dados - POST

Atenção

A importação de dados requer a especificação dos parâmetros do verbo POST da API listados abaixo e isso vale também para a importação através de arquivos via interface web.

Validação de coordenadas

Através da POST API é também possível enviar um conjunto de coordenadas geográficas (latitude e longitude) para validação e obter as localidades espacialmente relacionas (parcelas, unidades administrativas, etc..), sem registrar nada na base de dados. Usuários registrados tem acesso ao serviço.

Endpoint	Descrição	Parâmetros
bibreferences	Referências bibliográficas (GET lista, POST cria).	bibtex, doi
biocollections	Biocoleções (GET lista, POST cria).	acronym, name
individuals	Indivíduos (GET lista, POST cria, PUT atualiza).	altitude, angle, biocollection, biocollection_number, biocollection_type, collector, dataset, date, distance, identification_based_on_biocollection, identification_based_on_biocollection_number, identification_date, identification_individual, identification_notes, identifier, latitude, location, location_date_time, location_notes, longitude, modifier, notes, tag, taxon, x, y
individual-locations	Ocorrências para indivíduos com múltiplas localizações (GET lista, POST/PUT grava).	altitude, angle, distance, individual, latitude, location, location_date_time, location_notes, longitude, x, y
locations	Localidades (GET lista, POST cria, PUT atualiza).	adm_level, altitude, azimuth, datum, geojson, geom, ismarine, lat, long, name, notes, parent, startx, starty, x, y
locations-validation	Valida coordenadas com locais registrados (POST).	latitude, longitude
measurements	Medições de traits (GET lista, POST cria via job de importação, PUT atualiza).	bibreference, dataset, date, duplicated, link_id, location, notes, object_id, object_type, parent_measurement, person, trait_id, value
media	Metadados de mídia (GET lista, POST cria, PUT atualiza).	collector, dataset, date, filename, latitude, license, location, longitude, notes, object_id, object_type, project, tags, title_en, title_pt
persons	Pessoas (GET lista, POST cria, PUT atualiza).	abbreviation, biocollection, email, full_name, institution
taxons	Nomes taxonômicos (GET lista, POST cria).	author, author_id, bibkey, bibreference, enforceValid, gbif, indexfungorum, ipni, level, mobot, mycobank, name, parent, parent_id, parent_name, person, senior, senior_id, valid, zoobank
traits	Definições de traits (GET lista, POST cria).	bibreference, categories, description, export_name, link_type, name, objects, parent, range_max, range_min, tags, type, unit, value_length, wavenumber_max, wavenumber_min
vernaculars	Nomes vernáculos (GET lista, POST cria).	citations, individuals, language, name, notes, parent, taxons, type
vouchers	Vouchers de coleção (GET lista, POST cria, PUT atualiza).	biocollection, biocollection_number, biocollection_type, collector, dataset, date, individual, notes, number
datasets	Datasets e versões publicadas de datasets (GET lista, POST cria via job de importação).	description, license, name, privacy, project_id, share_taxon_list, title, visibility
identification-histories	Histórico de identificações (GET lista, POST cria linhas manuais de histórico).	biocollection_id, biocollection_reference, date, identification_id, identifier, identifier_id, identifiers, individual_id, modifier, notes, replaced_at, source, taxon_id

Atualizar dados - PUT

Atenção

Somente os endpoints listados abaixo podem ser atualizados usando a API e somente os campos PUT listados podem ser atualizados em cada endpoint. Os valores dos campos são os mesmos como explicados para a API POST, exceto que em todos os casos o id do registro a ser atualizado também deve ser fornecido.

Endpoint	Descrição	Parâmetros
individuals	Indivíduos (GET lista, POST cria, PUT atualiza).	id, collector, dataset, date, identification_based_on_biocollection, identification_based_on_biocollection_number, identification_date, identification_individual, identification_notes, identifier, individual_id, modifier, notes, tag, taxon
individual-locations	Ocorrências para indivíduos com múltiplas localizações (GET lista, POST/PUT grava).	id, altitude, angle, distance, individual, individual_location_id, latitude, location, location_date_time, location_notes, longitude, x, y
locations	Localidades (GET lista, POST cria, PUT atualiza).	id, adm_level, altitude, datum, geom, ismarine, lat, location_id, long, name, notes, parent, startx, starty, x, y
measurements	Medições de traits (GET lista, POST cria via job de importação, PUT atualiza).	id, bibreference, dataset, date, duplicated, link_id, location, measurement_id, notes, object_id, object_type, parent_measurement, person, trait_id, value
media	Metadados de mídia (GET lista, POST cria, PUT atualiza).	id, collector, dataset, date, latitude, license, location, longitude, media_id, media_uuid, notes, project, tags, title_en, title_pt
persons	Pessoas (GET lista, POST cria, PUT atualiza).	id, abbreviation, biocollection, email, full_name, institution, person_id
vouchers	Vouchers de coleção (GET lista, POST cria, PUT atualiza).	id, biocollection, biocollection_number, biocollection_type, clear_biocollection_number, collector, dataset, date, individual, notes, number, voucher_id
taxons	Nomes taxonômicos (GET lista, POST cria).	id, author, author_id, bibkey, bibreference, bibreference_id, enforceValid, gbif, indexfungorum, ipni, level, mobot, mycobank, name, notes, parent, parent_id, parent_name, person, senior_id, taxon_id, valid, zoobank

Nomenclature Types

Tipo Nomenclatural : código numérico
NotType : 0	Isosyntype : 8
Type : 1	Neotype : 9
Holotype : 2	Epitype : 10
Isotype : 3	Isoepitype : 11
Paratype : 4	Cultivartype : 12
Lectotype : 5	Clonotype : 13
Isolectotype : 6	Topotype : 14
Syntype : 7	Phototype : 15

Níveis taxonômicos (Ranks)

Código	Nível
-100	`clade`
0	`kingdom`
10	`subkingd.`
30	`div., phyl., phylum, division`
40	`subdiv.`
60	`cl., class`
70	`subcl., subclass`
80	`superord., superorder`
90	`ord., order`
100	`subord.`
120	`fam., family`
130	`subfam., subfamily`
150	`tr., tribe`
180	`gen., genus`
190	`subg., subgenus, sect.`
210	`section, sp., spec., species`
220	`subsp., subspecies`
240	`var., variety`
270	`f., fo., form`

2 - Obter dados - GET

Como obter dados usando a GET API!

O pacote OpenDataBio é um cliente para esta API, exemplos de uso aqui;
Token de autenticação necessário apenas para obter dados com uma política de acesso não pública

Parâmetros GET compartilhados

Baixar muitos dados?

Os parâmetros limit e offset podem ser usados para dividir sua busca em partes.

Alternativamente, use a opção save_job=T e depois baixe os dados com o parametro get_file=T da API userjobs.

wildcards

Quando múltiplos parâmetros são especificados eles são combinados com o operador AND. Não há opção de parâmetro OR nas suas buscas.

Parâmetro	Obrigatório	Descrição	Exemplo
`id`	Não	Id unico ou lista separada por virgula para filtrar/selecionar registros.	`1,2,3`
`limit`	Não	Quantidade maxima de registros retornados.	`100`
`offset`	Não	A posição inicial do conjunto de registros a ser exportado. Usado em conjunto com `limit` para limitar os resultados.	`10000`
`fields`	Não	Lista separada por vírgulas dos campos a serem incluídos na resposta ou uma palavra especial all/simple/raw, padrão: simple	`id,scientificName ou all`
`save_job`	Não	Se 1, salva a consulta como job para baixar depois via userjobs + get_file = 1	`1`

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âmetro	Obrigatório	Descrição	Exemplo
`id`	Não	Id unico ou lista separada por virgula para filtrar/selecionar registros.	`1,2,3`
`bibkey`	Não	Bibkey ou lista de bibkeys.	`ducke1953,mayr1992`
`biocollection`	Não	Id/nome/sigla de biocoleção; retorna referências que citam vouchers dessas coleções.	`INPA`
`dataset`	Não	Id ou nome de dataset; retorna referências ligadas ao dataset.	`Forest1`
`fields`	Não	Lista separada por vírgulas dos campos a serem incluídos na resposta ou uma palavra especial all/simple/raw, padrão: simple	`id,scientificName ou all`
`job_id`	Não	Id do job para reutilizar affected_ids ou filtrar resultados.	`1024`
`limit`	Não	Quantidade maxima de registros retornados.	`100`
`offset`	Não	A posição inicial do conjunto de registros a ser exportado. Usado em conjunto com `limit` para limitar os resultados.	`10000`
`save_job`	Não	Se 1, salva a consulta como job para baixar depois via userjobs + get_file = 1	`1`
`search`	Não	Busca full-text no bibtex em modo booleano; espaços funcionam como AND.	`Amazon forest`
`taxon`	Não	Lista de ids ou nomes canônicos de taxon; retorna referências ligadas ao taxon.	`Ocotea guianensis,Minquartia guianensis ou 120,455`
`taxon_root`	Não	Id/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.

Campo	Perfis	Significado
`id`	`simple` / `all`	Identificador numérico interno do registro exportado nesta instalação OpenDataBio.
`uuid`	`simple` / `all`	UUID estável do registro exportado.
`bibkey`	`simple` / `all`	Chave curta local OpenDataBio usada para identificar uma referência bibliográfica.
`year`	`simple` / `all`	Ano de publicação de uma referência bibliográfica.
`author`	`simple` / `all`	Texto de autoria de uma referência bibliográfica ou nome taxonômico, dependendo do endpoint.
`title`	`simple` / `all`	Título de uma referência bibliográfica ou dataset, dependendo do endpoint.
`doi`	`simple` / `all`	Digital Object Identifier associado a uma referência bibliográfica.
`url`	`simple` / `all`	URL associada a uma referência bibliográfica.
`bibtex`	`simple` / `all`	Representaçã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âmetro	Obrigatório	Descrição	Exemplo
`id`	Não	Id unico ou lista separada por virgula para filtrar/selecionar registros.	`1,2,3`
`acronym`	Não	Sigla da biocoleção.	`INPA`
`fields`	Não	Lista separada por vírgulas dos campos a serem incluídos na resposta ou uma palavra especial all/simple/raw, padrão: simple	`id,scientificName ou all`
`irn`	Não	IRN do Index Herbariorum para filtrar biocoleções.	`123456`
`job_id`	Não	Id do job para reutilizar affected_ids ou filtrar resultados.	`1024`
`limit`	Não	Quantidade maxima de registros retornados.	`100`
`name`	Não	Nome exato da biocoleção (string simples).	`Herbário do INPA`
`offset`	Não	A posição inicial do conjunto de registros a ser exportado. Usado em conjunto com `limit` para limitar os resultados.	`10000`
`save_job`	Não	Se 1, salva a consulta como job para baixar depois via userjobs + get_file = 1	`1`
`search`	Não	Parametro 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.

Campo	Perfis	Significado
`id`	`simple` / `all`	Identificador numérico interno do registro exportado nesta instalação OpenDataBio.
`uuid`	`simple` / `all`	UUID estável do registro exportado.
`acronym`	`simple` / `all`	Sigla local OpenDataBio de um projeto ou biocoleção.
`name`	`simple` / `all`	Nome local OpenDataBio do recurso exportado.
`irn`	`simple` / `all`	Número de registro institucional local OpenDataBio de uma biocoleção.
`country`	`all`	Nome ou código do país associado a uma localidade, coleção ou linha de exportação BRAHMS.
`city`	`all`	Cidade local OpenDataBio registrada para uma biocoleção.
`address`	`all`	Texto 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âmetro	Obrigatório	Descrição	Exemplo
`id`	Não	Id unico ou lista separada por virgula para filtrar/selecionar registros.	`1,2,3`
`bibreference`	Não	Id ou bibkey da referência.	`34`
`fields`	Não	Lista separada por vírgulas dos campos a serem incluídos na resposta ou uma palavra especial all/simple/raw, padrão: simple	`id,scientificName ou all`
`has_versions`	Não	Quando 1, retorna apenas datasets que possuem versões publicas.	`1`
`include_url`	Não	Quando 1 com list_versions, inclui URL do archive.	`1`
`limit`	Não	Quantidade maxima de registros retornados.	`100`
`list_versions`	Não	Se 1, lista arquivos de versões de dataset para os ids informados.	`1`
`name`	Não	Parametro generico de nome (taxon completo, local, export_name de trait, etc.).	`Ocotea guianensis`
`offset`	Não	A posição inicial do conjunto de registros a ser exportado. Usado em conjunto com `limit` para limitar os resultados.	`10000`
`project`	Não	Id ou sigla do projeto.	`PDBFF ou 2`
`save_job`	Não	Se 1, salva a consulta como job para baixar depois via userjobs + get_file = 1	`1`
`search`	Não	Parametro de busca de texto.	`Silva`
`summarize`	Não	Id do dataset para retornar sumarios de conteudo/taxonomia/traits.	`3`
`tag`	Não	Tag/número/código do indivíduo.	`A-1234`
`tagged_with`	Não	Ids de tags (virgula) ou texto para filtrar datasets por tags (lista de ids ou full-text).	`12,13 ou copa folha`
`taxon`	Não	Id ou nome canônico do taxon (lista aceita).	`Licaria cannela,Licaria armeniaca ou 456,789`
`taxon_root`	Não	Id/nome de taxon incluindo descendentes.	`Lauraceae`
`traits`	Não	Lista de ids de traits (separados por virgula) para filtrar datasets.	`12,15`
`version_id`	Não	Id da versão de dataset para listar ou baixar.	`34`
`version_uuid`	Não	UUID 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.

Campo	Perfis	Significado
`id`	`simple` / `all`	Identificador numérico interno do registro exportado nesta instalação OpenDataBio.
`uuid`	`simple` / `all`	UUID estável do registro exportado.
`name`	`simple` / `all`	Nome local OpenDataBio do recurso exportado.
`title`	`simple` / `all`	Título de uma referência bibliográfica ou dataset, dependendo do endpoint.
`projectName`	`simple` / `all`	Nome ou sigla do projeto ligado ao registro ou dataset.
`project_id`	`simple` / `all`	Identificador numérico interno do projeto ligado ao registro ou dataset.
`project_uuid`	`simple` / `all`	UUID estável do projeto ligado ao registro ou dataset.
`description`	`simple` / `all`	Texto descritivo local OpenDataBio do recurso exportado.
`notes`	`simple` / `all`	Notas locais OpenDataBio associadas ao recurso exportado.
`contactEmail`	`simple` / `all`	E-mail de contato local OpenDataBio configurado para o dataset.
`taggedWidth`	`simple` / `all`	Lista local OpenDataBio de tags associadas a um dataset. Este nome de campo legado é mantido por compatibilidade da API.
`policyCode`	`simple` / `all`	Código compacto da política derivado da licença do dataset e das obrigações de uso.
`privacyLevel`	`all`	Nível de acesso interno local OpenDataBio configurado para o dataset; não é licença.
`policy`	`all`	Texto completo da política de dados armazenado localmente para um dataset.
`measurements_count`	`all`	Contagem local OpenDataBio de medições ligadas ao dataset.
`policyUrl`	`all`	URL onde a política completa do dataset ou versão pode ser consultada.
`policySummary`	`all`	Resumo 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âmetro	Obrigatório	Descrição	Exemplo
`id`	Não	Id unico ou lista separada por virgula para filtrar/selecionar registros.	`1,2,3`
`dataset`	Não	Id/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_max`	Não	Data final inclusiva (AAAA-MM-DD) comparada com a data do indivíduo.	`2024-12-31`
`date_min`	Não	Data inicial inclusiva (AAAA-MM-DD) comparada com a data do indivíduo.	`2020-01-01`
`fields`	Não	Lista separada por vírgulas dos campos a serem incluídos na resposta ou uma palavra especial all/simple/raw, padrão: simple	`id,scientificName ou all`
`job_id`	Não	Id do job para reutilizar affected_ids ou filtrar resultados.	`1024`
`limit`	Não	Quantidade maxima de registros retornados.	`100`
`location`	Não	Lista de ids/nomes de locais; retorna indivíduos ligados à esses locais.	`Parcela 25ha ou 55,60`
`location_root`	Não	Id/nome de local; inclui descendentes dos locais informados; retorna individuos dentro dos locais informados	`Amazonas`
`odbrequest_id`	Não	Id de request para filtrar indivíduos vinculados a esse pedido ODB.	`12`
`offset`	Não	A posição inicial do conjunto de registros a ser exportado. Usado em conjunto com `limit` para limitar os resultados.	`10000`
`person`	Não	Ids/nomes/abreviação/emails de coletores	`Silva, J.B. da, Assunção, P.C.L. ou Paulo Apóstolo Costa Lima Assunção ou 3,567,300`
`project`	Não	Id/nome de projeto; filtra indivíduos cujo dataset pertence ao projeto.	`PDBFF`
`save_job`	Não	Se 1, salva a consulta como job para baixar depois via userjobs + get_file = 1	`1`
`tag`	Não	Filtro por tag/número de indivíduo; aceita lista separada por virgula.	`A-123,2001,24,54`
`taxon`	Não	Lista de ids/nomes de taxon; filtra pela identificacao exata (sem descendentes).	`Licaria cannela ou 456`
`taxon_root`	Não	Lista de ids/nomes de taxon; inclui descendentes de cada taxon.	`Lauraceae`
`trait`	Não	Ids/export_name de traits; retorna indivíduos que tem medições para esses traits	`12,15 ou treeDbh,treeDbhPom`
`vernacular`	Não	Ids/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.

Campo	Perfis	Significado
`id`	`simple` / `all`	Identificador numérico interno do registro exportado nesta instalação OpenDataBio.
`uuid`	`simple` / `all`	UUID estável do registro exportado.
`dataset_id`	`simple` / `all`	Identificador numérico interno do dataset que governa o registro exportado.
`basisOfRecord`	`simple` / `all`	Coluna Darwin Core: valor basisOfRecord indicando o tipo geral de registro biológico.
`organismID`	`simple` / `all`	Coluna Darwin Core: identificador estável do organismo/indivíduo, formatado pelo OpenDataBio como `odb:{installation}:individual:{uuid}`.
`organismName`	`simple` / `all`	Coluna Darwin Core: rótulo legível do organismo ou registro de indivíduo.
`recordedByMain`	`simple` / `all`	Coletor ou observador principal responsável pelo registro.
`recordNumber`	`simple` / `all`	Coluna Darwin Core: número de coleta ou observação.
`eventDate`	`simple` / `all`	Coluna Darwin Core: data ou intervalo em que ocorreu o evento de coleta, observação, captura da mídia ou ocorrência.
`family`	`simple` / `all`	Coluna taxonômica Darwin Core: família associada ao táxon exportado ou organismo identificado.
`scientificName`	`simple` / `all`	Coluna taxonômica Darwin Core: nome científico associado ao registro no momento da exportação.
`identificationQualifier`	`simple` / `all`	Coluna Darwin Core: qualificador que expressa incerteza ou condição da identificação.
`identifiedBy`	`simple` / `all`	Coluna Darwin Core: pessoa ou pessoas responsáveis pela identificação taxonômica.
`dateIdentified`	`simple` / `all`	Coluna Darwin Core: data em que a identificação taxonômica foi feita.
`locationName`	`simple` / `all`	Rótulo de localidade compatível com Darwin Core usado pelo OpenDataBio para a localidade associada ao registro.
`locationParentName`	`simple` / `all`	Nome da localidade pai que contém a localidade do registro.
`higherGeography`	`simple` / `all`	Coluna Darwin Core: contexto geográfico superior da localidade, como localidades parentais ou hierarquia administrativa.
`decimalLatitude`	`simple` / `all`	Coluna Darwin Core: latitude em graus decimais, quando coordenadas estão disponíveis para distribuição.
`decimalLongitude`	`simple` / `all`	Coluna Darwin Core: longitude em graus decimais, quando coordenadas estão disponíveis para distribuição.
`x`	`simple` / `all`	Campo local OpenDataBio para posição de ocorrência: coordenada cartesiana X do indivíduo dentro da parcela, transecto ou localidade parental.
`y`	`simple` / `all`	Campo 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.
`gx`	`simple` / `all`	Coordenada X projetada ou de grade local OpenDataBio da posição de um indivíduo, quando disponível.
`gy`	`simple` / `all`	Coordenada Y projetada ou de grade local OpenDataBio da posição de um indivíduo, quando disponível.
`angle`	`simple` / `all`	Azimute local OpenDataBio, em graus, de um ponto de referência até a posição de ocorrência.
`distance`	`simple` / `all`	Distância local OpenDataBio, em metros, de um ponto de referência até a posição de ocorrência.
`datasetID`	`simple` / `all`	Coluna 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.
`datasetName`	`simple` / `all`	Coluna Darwin Core: nome ou título do dataset que governa o registro exportado.
`accessRights`	`simple` / `all`	Coluna 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.
`policyCode`	`simple` / `all`	Código compacto da política derivado da licença do dataset e das obrigações de uso.
`recordedDate`	`all`	Coluna legada OpenDataBio equivalente a Darwin Core eventDate. Mantida em exportações `all` por compatibilidade; prefira eventDate para interoperabilidade.
`recordedBy`	`all`	Coluna Darwin Core: coletores ou observadores associados ao registro.
`scientificNameAuthorship`	`all`	Coluna taxonômica Darwin Core: texto de autoria associado ao nome científico.
`taxon_id`	`all`	Identificador numérico interno do nome taxonômico ligado.
`taxon_uuid`	`all`	UUID estável do nome taxonômico ligado.
`identification_id`	`all`	Identificador numérico interno da identificação taxonômica ligada ao registro.
`identification_uuid`	`all`	UUID estável da identificação taxonômica ligada ao registro.
`taxonPublishedStatus`	`all`	Status de publicação do nome taxonômico usado na identificação.
`genus`	`all`	Coluna taxonômica Darwin Core: gênero associado ao táxon exportado ou organismo identificado.
`identificationRemarks`	`all`	Coluna Darwin Core: notas associadas à identificação taxonômica.
`identificationBiocollection`	`all`	Biocoleção usada como referência para a identificação, quando aplicável.
`identificationBiocollectionReference`	`all`	Número de catálogo ou referência na biocoleção usada para identificação.
`location_id`	`all`	Identificador numérico interno da localidade ligada.
`location_uuid`	`all`	UUID estável da localidade ligada.
`georeferenceRemarks`	`all`	Coluna Darwin Core: notas descrevendo origem das coordenadas, incerteza ou detalhes de georreferenciamento.
`relatedLocations`	`all`	Outras localidades relacionadas ao registro, como parcelas, transectos ou localidades de ocorrência ligadas.
`organismRemarks`	`all`	Coluna Darwin Core: observações sobre o organismo ou indivíduo.
`policyUrl`	`all`	URL onde a política completa do dataset ou versão pode ser consultada.
`policySummary`	`all`	Resumo 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âmetro	Obrigatório	Descrição	Exemplo
`id`	Não	Id unico ou lista separada por virgula para filtrar/selecionar registros.	`1,2,3`
`dataset`	Não	Id/nome de dataset; filtra pelo dataset do indivíduo vinculado.	`FOREST1`
`date_max`	Não	Data/hora maxima; compara date_time ou data do indivíduo quando vazio.	`2024-12-31`
`date_min`	Não	Data/hora minima; compara date_time ou data do indivíduo quando vazio.	`2020-01-01`
`fields`	Não	Lista separada por vírgulas dos campos a serem incluídos na resposta ou uma palavra especial all/simple/raw, padrão: simple	`id,scientificName ou all`
`individual`	Não	Lista de ids de indivíduos com ocorrências retornadas.	`12,44`
`limit`	Não	Quantidade maxima de registros retornados.	`100`
`location`	Não	Id ou nome do local.	`Parcela 25ha ou 55`
`location_root`	Não	Id/nome do local incluindo descendentes.	`Amazonas ou 10`
`offset`	Não	A posição inicial do conjunto de registros a ser exportado. Usado em conjunto com `limit` para limitar os resultados.	`10000`
`person`	Não	Ids/nomes/emails de coletores; filtra pelas coletas dos indivíduos.	`Silva, J.B.\|23`
`project`	Não	Id/nome de projeto; filtra ocorrências de indivíduos em datasets do projeto.	`PDBFF`
`save_job`	Não	Se 1, salva a consulta como job para baixar depois via userjobs + get_file = 1	`1`
`tag`	Não	Lista de tags/números de indivíduo; compara com individuals.number.	`A-123,B-2`
`taxon`	Não	Id ou nome canônico do taxon (lista aceita).	`Licaria cannela,Licaria armeniaca ou 456,789`
`taxon_root`	Não	Id/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.

Campo	Perfis	Significado
`id`	`simple` / `all`	Identificador numérico interno do registro exportado nesta instalação OpenDataBio.
`uuid`	`simple` / `all`	UUID estável do registro exportado.
`individual_id`	`simple` / `all`	Identificador numérico interno do indivíduo ou organismo ligado.
`individual_uuid`	`simple` / `all`	UUID estável do indivíduo ou organismo ligado.
`location_id`	`simple` / `all`	Identificador numérico interno da localidade ligada.
`location_uuid`	`simple` / `all`	UUID estável da localidade ligada.
`basisOfRecord`	`simple` / `all`	Coluna Darwin Core: valor basisOfRecord indicando o tipo geral de registro biológico.
`occurrenceID`	`simple` / `all`	Coluna 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.
`organismID`	`simple` / `all`	Coluna Darwin Core: identificador estável do organismo/indivíduo, formatado pelo OpenDataBio como `odb:{installation}:individual:{uuid}`.
`organismName`	`simple` / `all`	Coluna Darwin Core: rótulo legível do organismo ou registro de indivíduo.
`eventDate`	`simple` / `all`	Coluna Darwin Core: data ou intervalo em que ocorreu o evento de coleta, observação, captura da mídia ou ocorrência.
`locationName`	`simple` / `all`	Rótulo de localidade compatível com Darwin Core usado pelo OpenDataBio para a localidade associada ao registro.
`higherGeography`	`simple` / `all`	Coluna Darwin Core: contexto geográfico superior da localidade, como localidades parentais ou hierarquia administrativa.
`decimalLatitude`	`simple` / `all`	Coluna Darwin Core: latitude em graus decimais, quando coordenadas estão disponíveis para distribuição.
`decimalLongitude`	`simple` / `all`	Coluna Darwin Core: longitude em graus decimais, quando coordenadas estão disponíveis para distribuição.
`x`	`simple` / `all`	Campo local OpenDataBio para posição de ocorrência: coordenada cartesiana X desta ocorrência do indivíduo dentro da parcela, transecto ou localidade parental.
`y`	`simple` / `all`	Campo 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.
`angle`	`simple` / `all`	Azimute local OpenDataBio, em graus, de um ponto de referência até a posição de ocorrência.
`distance`	`simple` / `all`	Distância local OpenDataBio, em metros, de um ponto de referência até a posição de ocorrência.
`minimumElevation`	`simple` / `all`	Coluna Darwin Core: limite inferior de elevação da ocorrência ou localidade, em metros.
`occurrenceRemarks`	`simple` / `all`	Coluna Darwin Core: observações sobre a ocorrência.
`scientificName`	`simple` / `all`	Coluna taxonômica Darwin Core: nome científico associado ao registro no momento da exportação.
`family`	`simple` / `all`	Coluna taxonômica Darwin Core: família associada ao táxon exportado ou organismo identificado.
`datasetID`	`simple` / `all`	Coluna 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.
`datasetName`	`simple` / `all`	Coluna Darwin Core: nome ou título do dataset que governa o registro exportado.
`accessRights`	`simple` / `all`	Coluna 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.
`policyCode`	`simple` / `all`	Código compacto da política derivado da licença do dataset e das obrigações de uso.
`occurrenceName`	`all`	Rótulo legível de um registro de ocorrência.
`recordedDate`	`all`	Coluna legada OpenDataBio equivalente a Darwin Core eventDate. Mantida em exportações `all` por compatibilidade; prefira eventDate para interoperabilidade.
`georeferenceRemarks`	`all`	Coluna Darwin Core: notas descrevendo origem das coordenadas, incerteza ou detalhes de georreferenciamento.
`organismRemarks`	`all`	Coluna Darwin Core: observações sobre o organismo ou indivíduo.
`policyUrl`	`all`	URL onde a política completa do dataset ou versão pode ser consultada.
`policySummary`	`all`	Resumo 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âmetro	Obrigatório	Descrição	Exemplo
`fields`	Não	Lista separada por vírgulas dos campos a serem incluídos na resposta ou uma palavra especial all/simple/raw, padrão: simple	`id,scientificName ou all`
`limit`	Não	Quantidade maxima de registros retornados.	`100`
`offset`	Não	A 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âmetro	Obrigatório	Descrição	Exemplo
`id`	Não	Id unico ou lista separada por virgula para filtrar/selecionar registros.	`1,2,3`
`adm_level`	Não	Um ou mais códigos adm_level (separados por virgula ou array).	`10,100`
`dataset`	Não	Id/nome de dataset; expande para todas as locations usadas pelo dataset.	`FOREST1`
`fields`	Não	Lista separada por vírgulas dos campos a serem incluídos na resposta ou uma palavra especial all/simple/raw, padrão: simple	`id,scientificName ou all`
`job_id`	Não	Id do job para reutilizar affected_ids ou filtrar resultados.	`1024`
`lat`	Não	Latitude (graus decimais) usada com querytype.	`-3.11`
`limit`	Não	Quantidade maxima de registros retornados.	`100`
`location_root`	Não	Alias de root para compatibilidade.	`Amazonas`
`long`	Não	Longitude (graus decimais) usada com querytype.	`-60.02`
`name`	Não	Correspondencia exata de nome; aceita lista de nomes ou ids.	`Manaus`
`offset`	Não	A posição inicial do conjunto de registros a ser exportado. Usado em conjunto com `limit` para limitar os resultados.	`10000`
`parent_id`	Não	Id do pai para consultas hierarquicas.	`210`
`project`	Não	Id ou sigla do projeto.	`PDBFF ou 2`
`querytype`	Não	Quando lat/long informados: busca geometrica exact\|parent\|closest.	`parent`
`root`	Não	Id/nome de local; retorna ele e todos os descendentes/relacionados.	`Amazonas`
`save_job`	Não	Se 1, salva a consulta como job para baixar depois via userjobs + get_file = 1	`1`
`search`	Não	Busca prefixada no nome (SQL LIKE name%).	`Mana`
`taxon`	Não	Lista de ids/nomes de taxon; filtra locations por identificações vinculadas.	`Euterpe edulis`
`taxon_root`	Não	Lista de ids/nomes de taxon; inclui descendentes ao filtrar identificações vinculadas.	`Lauraceae`
`trait`	Não	Id/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.

Campo	Perfis	Significado
`id`	`simple` / `all`	Identificador numérico interno do registro exportado nesta instalação OpenDataBio.
`uuid`	`simple` / `all`	UUID estável do registro exportado.
`locationID`	`simple` / `all`	Coluna Darwin Core: identificador estável do registro de localidade, formatado pelo OpenDataBio como `odb:{installation}:location:{uuid}`.
`basisOfRecord`	`simple` / `all`	Coluna Darwin Core: valor basisOfRecord indicando o tipo geral de registro biológico.
`locationName`	`simple` / `all`	Rótulo de localidade compatível com Darwin Core usado pelo OpenDataBio para a localidade associada ao registro.
`adm_level`	`simple` / `all`	Código local OpenDataBio do nível administrativo de uma localidade.
`country_adm_level`	`simple` / `all`	Código local OpenDataBio do nível administrativo que representa o país.
`x`	`simple` / `all`	Campo local OpenDataBio para geometria da localidade: dimensão X ou comprimento de uma parcela/transecto no sistema de coordenadas local da localidade.
`y`	`simple` / `all`	Campo 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.
`startx`	`simple` / `all`	Coordenada X inicial local OpenDataBio de uma parcela, transecto ou sistema de coordenadas local.
`starty`	`simple` / `all`	Coordenada Y inicial local OpenDataBio de uma parcela, transecto ou sistema de coordenadas local.
`distance_to_search`	`simple` / `all`	Distância local OpenDataBio, geralmente em metros, entre uma localidade e a coordenada usada na busca.
`parent_id`	`simple` / `all`	Identificador numérico interno do registro pai em uma hierarquia.
`parent_uuid`	`simple` / `all`	UUID estável do registro pai em uma hierarquia.
`parentName`	`simple` / `all`	Nome local OpenDataBio da localidade pai.
`higherGeography`	`simple` / `all`	Coluna Darwin Core: contexto geográfico superior da localidade, como localidades parentais ou hierarquia administrativa.
`footprintWKT`	`simple` / `all`	Coluna Darwin Core: geometria da localidade em formato WKT, quando disponível.
`locationRemarks`	`simple` / `all`	Coluna Darwin Core: observações ou notas sobre a localidade.
`decimalLatitude`	`simple` / `all`	Coluna Darwin Core: latitude em graus decimais, quando coordenadas estão disponíveis para distribuição.
`decimalLongitude`	`simple` / `all`	Coluna Darwin Core: longitude em graus decimais, quando coordenadas estão disponíveis para distribuição.
`georeferenceRemarks`	`simple` / `all`	Coluna Darwin Core: notas descrevendo origem das coordenadas, incerteza ou detalhes de georreferenciamento.
`geodeticDatum`	`simple` / `all`	Coluna 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âmetro	Obrigatório	Descrição	Exemplo
`id`	Não	Id unico ou lista separada por virgula para filtrar/selecionar registros.	`1,2,3`
`bibreference`	Não	Id ou bibkey da referência.	`34`
`dataset`	Não	Id ou sigla do dataset.	`3 ou FOREST1`
`date_max`	Não	Filtra registros ate esta data (AAAA-MM-DD).	`2024-12-31`
`date_min`	Não	Filtra registros a partir desta data (AAAA-MM-DD).	`2020-01-01`
`fields`	Não	Lista separada por vírgulas dos campos a serem incluídos na resposta ou uma palavra especial all/simple/raw, padrão: simple	`id,scientificName ou all`
`individual`	Não	Id, uuid ou organismID do indivíduo.	`4521 ou 2ff0e884-3d33`
`job_id`	Não	Id do job para reutilizar affected_ids ou filtrar resultados.	`1024`
`limit`	Não	Quantidade maxima de registros retornados.	`100`
`location`	Não	Id ou nome do local.	`Parcela 25ha ou 55`
`location_root`	Não	Id/nome do local incluindo descendentes.	`Amazonas ou 10`
`measured_id`	Não	Filtro de measurement: id do objeto medido (coerente com measured_type).	`4521`
`measured_type`	Não	Filtro de measurement: classe do objeto medido (Individual, Location, Taxon, Voucher, Media).	`Media`
`offset`	Não	A posição inicial do conjunto de registros a ser exportado. Usado em conjunto com `limit` para limitar os resultados.	`10000`
`person`	Não	Id/abreviação/nome/email de pessoa (aceita lista com \| ou ;).	`Silva, J.B.\|Costa, M.`
`project`	Não	Id ou sigla do projeto.	`PDBFF ou 2`
`save_job`	Não	Se 1, salva a consulta como job para baixar depois via userjobs + get_file = 1	`1`
`taxon`	Não	Id ou nome canônico do taxon (lista aceita).	`Licaria cannela,Licaria armeniaca ou 456,789`
`taxon_root`	Não	Id/nome de taxon incluindo descendentes.	`Lauraceae`
`trait`	Não	Id ou export_name do trait para filtro.	`DBH`
`trait_type`	Não	Filtra measurements pelo código do tipo de trait.	`1`
`voucher`	Não	Id 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.

Campo	Perfis	Significado
`id`	`simple` / `all`	Identificador numérico interno do registro exportado nesta instalação OpenDataBio.
`uuid`	`simple` / `all`	UUID estável do registro exportado.
`measurementID`	`simple` / `all`	Coluna Darwin Core: identificador estável do registro de medição, formatado pelo OpenDataBio como `odb:{installation}:measurement:{uuid}`.
`dataset_id`	`simple` / `all`	Identificador numérico interno do dataset que governa o registro exportado.
`basisOfRecord`	`simple` / `all`	Coluna Darwin Core: valor basisOfRecord indicando o tipo geral de registro biológico.
`measured_type`	`simple` / `all`	Tipo de modelo local OpenDataBio do objeto medido por um registro de medição.
`measured_id`	`simple` / `all`	Identificador numérico interno do objeto medido por um registro de medição.
`measured_uuid`	`simple` / `all`	UUID estável do objeto medido por um registro de medição, quando o objeto possui UUID.
`trait_id`	`simple` / `all`	Identificador numérico interno do trait ligado.
`trait_uuid`	`simple` / `all`	UUID estável do trait ligado.
`measurementType`	`simple` / `all`	Coluna Darwin Core MeasurementOrFact: nome de exportação do trait ou tipo de medição representado.
`measurementValue`	`simple` / `all`	Coluna Darwin Core MeasurementOrFact: valor registrado da medição.
`measurementUnit`	`simple` / `all`	Coluna Darwin Core MeasurementOrFact: unidade associada ao valor da medição.
`measurementDeterminedBy`	`simple` / `all`	Coluna Darwin Core MeasurementOrFact: pessoa ou pessoas que determinaram ou registraram a medição.
`measurementDeterminedDate`	`simple` / `all`	Coluna Darwin Core MeasurementOrFact: data em que a medição foi determinada ou registrada.
`scientificName`	`simple` / `all`	Coluna taxonômica Darwin Core: nome científico associado ao registro no momento da exportação.
`family`	`simple` / `all`	Coluna taxonômica Darwin Core: família associada ao táxon exportado ou organismo identificado.
`datasetID`	`simple` / `all`	Coluna 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.
`datasetName`	`simple` / `all`	Coluna Darwin Core: nome ou título do dataset que governa o registro exportado.
`sourceCitation`	`simple` / `all`	Citação da fonte da qual o registro ou medição foi derivado.
`accessRights`	`simple` / `all`	Coluna 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.
`policyCode`	`simple` / `all`	Código compacto da política derivado da licença do dataset e das obrigações de uso.
`dataset_uuid`	`all`	UUID estável do dataset que governa o registro exportado.
`measurementRemarks`	`all`	Coluna Darwin Core MeasurementOrFact: notas associadas à medição.
`resourceRelationship`	`all`	Coluna Darwin Core ResourceRelationship: tipo de relação entre o registro exportado e o recurso ao qual ele está ligado.
`resourceRelationshipID`	`all`	Coluna 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.
`resourceRelationshipName`	`all`	Coluna compatível com Darwin Core ResourceRelationship: nome legível do recurso relacionado.
`relationshipOfResource`	`all`	Valor Darwin Core relationshipOfResource descrevendo como o recurso está relacionado.
`measurementMethod`	`all`	Coluna Darwin Core MeasurementOrFact: método ou protocolo usado para obter a medição.
`bibreference_id`	`all`	Identificador numérico interno da referência bibliográfica ligada.
`bibreference_uuid`	`all`	UUID estável da referência bibliográfica ligada.
`measurementLocationId`	`all`	Identificador numérico interno da localidade associada à medição.
`measurementLocationUuid`	`all`	UUID estável da localidade associada à medição.
`measurementParentId`	`all`	Identificador numérico interno da medição pai quando esta medição é aninhada.
`measurementParentUuid`	`all`	UUID estável da medição pai quando esta medição é aninhada.
`decimalLatitude`	`all`	Coluna Darwin Core: latitude em graus decimais, quando coordenadas estão disponíveis para distribuição.
`decimalLongitude`	`all`	Coluna Darwin Core: longitude em graus decimais, quando coordenadas estão disponíveis para distribuição.
`policyUrl`	`all`	URL onde a política completa do dataset ou versão pode ser consultada.
`policySummary`	`all`	Resumo 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âmetro	Obrigatório	Descrição	Exemplo
`id`	Não	Id unico ou lista separada por virgula para filtrar/selecionar registros.	`1,2,3`
`dataset`	Não	Id ou sigla do dataset.	`3 ou FOREST1`
`fields`	Não	Lista separada por vírgulas dos campos a serem incluídos na resposta ou uma palavra especial all/simple/raw, padrão: simple	`id,scientificName ou all`
`individual`	Não	Id, uuid ou organismID do indivíduo.	`4521 ou 2ff0e884-3d33`
`job_id`	Não	Id do job para reutilizar affected_ids ou filtrar resultados.	`1024`
`limit`	Não	Quantidade maxima de registros retornados.	`100`
`location`	Não	Id ou nome do local.	`Parcela 25ha ou 55`
`location_root`	Não	Id/nome do local incluindo descendentes.	`Amazonas ou 10`
`media_id`	Não	Id numerico de mídia.	`88`
`media_uuid`	Não	UUID da mídia.	`a3f0a4ac-6b5b-11ed-b8c0-0242ac120002`
`offset`	Não	A posição inicial do conjunto de registros a ser exportado. Usado em conjunto com `limit` para limitar os resultados.	`10000`
`person`	Não	Id/abreviação/nome/email de pessoa (aceita lista com \| ou ;).	`Silva, J.B.\|Costa, M.`
`project`	Não	Id ou sigla do projeto.	`PDBFF ou 2`
`save_job`	Não	Se 1, salva a consulta como job para baixar depois via userjobs + get_file = 1	`1`
`tag`	Não	Tag/número/código do indivíduo.	`A-1234`
`taxon`	Não	Id ou nome canônico do taxon (lista aceita).	`Licaria cannela,Licaria armeniaca ou 456,789`
`taxon_root`	Não	Id/nome de taxon incluindo descendentes.	`Lauraceae`
`uuid`	Não		—
`voucher`	Não	Id 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.

Campo	Perfis	Significado
`id`	`simple` / `all`	Identificador numérico interno do registro exportado nesta instalação OpenDataBio.
`uuid`	`simple` / `all`	UUID estável do registro exportado.
`model_type`	`simple` / `all`	Classe de modelo local OpenDataBio do objeto ligado a um registro de mídia.
`model_id`	`simple` / `all`	Identificador numérico interno do objeto OpenDataBio ligado a um registro de mídia.
`model_uuid`	`simple` / `all`	UUID estável do objeto OpenDataBio ligado a um registro de mídia.
`dataset_id`	`simple` / `all`	Identificador numérico interno do dataset que governa o registro exportado.
`dataset_uuid`	`simple` / `all`	UUID estável do dataset que governa o registro exportado.
`project_id`	`simple` / `all`	Identificador numérico interno do projeto ligado ao registro ou dataset.
`project_uuid`	`simple` / `all`	UUID estável do projeto ligado ao registro ou dataset.
`basisOfRecord`	`simple` / `all`	Coluna Darwin Core: valor basisOfRecord indicando o tipo geral de registro biológico.
`recordedBy`	`simple` / `all`	Coluna Darwin Core: coletores ou observadores associados ao registro.
`eventDate`	`simple` / `all`	Coluna Darwin Core: data ou intervalo em que ocorreu o evento de coleta, observação, captura da mídia ou ocorrência.
`dwcType`	`simple` / `all`	Valor Darwin Core / Dublin Core de tipo da mídia ou recurso ligado.
`resourceRelationship`	`simple` / `all`	Coluna Darwin Core ResourceRelationship: tipo de relação entre o registro exportado e o recurso ao qual ele está ligado.
`resourceRelationshipID`	`simple` / `all`	Coluna 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.
`resourceRelationshipName`	`simple` / `all`	Coluna compatível com Darwin Core ResourceRelationship: nome legível do recurso relacionado.
`relationshipOfResource`	`simple` / `all`	Valor Darwin Core relationshipOfResource descrevendo como o recurso está relacionado.
`scientificName`	`simple` / `all`	Coluna taxonômica Darwin Core: nome científico associado ao registro no momento da exportação.
`family`	`simple` / `all`	Coluna taxonômica Darwin Core: família associada ao táxon exportado ou organismo identificado.
`datasetID`	`simple` / `all`	Coluna 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.
`datasetName`	`simple` / `all`	Coluna Darwin Core: nome ou título do dataset que governa o registro exportado.
`projectName`	`simple` / `all`	Nome ou sigla do projeto ligado ao registro ou dataset.
`taggedWith`	`simple` / `all`	Tags ou palavras-chave associadas ao registro.
`accessRights`	`simple` / `all`	Coluna 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.
`policyCode`	`simple` / `all`	Código compacto da política derivado da licença do dataset e das obrigações de uso.
`license`	`simple` / `all`	Licença atribuída ao arquivo de mídia ou recurso de dataset.
`file_name`	`simple` / `all`	Nome do arquivo armazenado para uma mídia ou arquivo de dataset para download.
`file_url`	`simple` / `all`	URL pública para recuperar o arquivo de mídia ou arquivo de download.
`citation`	`simple` / `all`	Citação legível associada ao registro ou arquivo de mídia.
`recordedDate`	`all`	Coluna legada OpenDataBio equivalente a Darwin Core eventDate. Mantida em exportações `all` por compatibilidade; prefira eventDate para interoperabilidade.
`policyUrl`	`all`	URL onde a política completa do dataset ou versão pode ser consultada.
`policySummary`	`all`	Resumo curto, em linguagem simples, das permissões e obrigações de uso.
`bibliographicCitation`	`all`	Coluna Darwin Core / Dublin Core: citação bibliográfica formatada associada ao registro.
`bibtex`	`all`	Representação BibTeX da referência bibliográfica ou citação de mídia.
`userName`	`all`	Nome do usuário OpenDataBio associado à ação no registro.
`created_at`	`all`	Data 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âmetro	Obrigatório	Descrição	Exemplo
`id`	Não	Id unico ou lista separada por virgula para filtrar/selecionar registros.	`1,2,3`
`abbrev`	Não	Busca por abreviação de pessoa.	`Silva, J.B.`
`email`	Não	Endereco de email.	`user@example.org`
`fields`	Não	Lista separada por vírgulas dos campos a serem incluídos na resposta ou uma palavra especial all/simple/raw, padrão: simple	`id,scientificName ou all`
`job_id`	Não	Id do job para reutilizar affected_ids ou filtrar resultados.	`1024`
`limit`	Não	Quantidade maxima de registros retornados.	`100`
`name`	Não	Parametro generico de nome (taxon completo, local, export_name de trait, etc.).	`Ocotea guianensis`
`offset`	Não	A posição inicial do conjunto de registros a ser exportado. Usado em conjunto com `limit` para limitar os resultados.	`10000`
`save_job`	Não	Se 1, salva a consulta como job para baixar depois via userjobs + get_file = 1	`1`
`search`	Não	Parametro 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.

Campo	Perfis	Significado
`id`	`simple` / `all`	Identificador numérico interno do registro exportado nesta instalação OpenDataBio.
`uuid`	`simple` / `all`	UUID estável do registro exportado.
`full_name`	`simple` / `all`	Nome completo local OpenDataBio de uma pessoa.
`abbreviation`	`simple` / `all`	Abreviação local OpenDataBio de uma pessoa ou biocoleção.
`emailAddress`	`simple` / `all`	E-mail local OpenDataBio de pessoa quando está disponível para exportação.
`institution`	`simple` / `all`	Instituição local OpenDataBio associada a uma pessoa.
`orcid`	`simple` / `all`	Identificador ORCID associado a uma pessoa.
`notes`	`simple` / `all`	Notas 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âmetro	Obrigatório	Descrição	Exemplo
`id`	Não	Id unico ou lista separada por virgula para filtrar/selecionar registros.	`1,2,3`
`fields`	Não	Lista separada por vírgulas dos campos a serem incluídos na resposta ou uma palavra especial all/simple/raw, padrão: simple	`id,scientificName ou all`
`job_id`	Não	Id do job para reutilizar affected_ids ou filtrar resultados.	`1024`
`limit`	Não	Quantidade maxima de registros retornados.	`100`
`offset`	Não	A posição inicial do conjunto de registros a ser exportado. Usado em conjunto com `limit` para limitar os resultados.	`10000`
`save_job`	Não	Se 1, salva a consulta como job para baixar depois via userjobs + get_file = 1	`1`
`search`	Não	Parametro de busca de texto.	`Silva`
`tag`	Não	Tag/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.

Campo	Perfis	Significado
`id`	`simple` / `all`	Identificador numérico interno do registro exportado nesta instalação OpenDataBio.
`uuid`	`simple` / `all`	UUID estável do registro exportado.
`acronym`	`simple` / `all`	Sigla local OpenDataBio de um projeto ou biocoleção.
`name`	`simple` / `all`	Nome local OpenDataBio do recurso exportado.
`description`	`simple` / `all`	Texto descritivo local OpenDataBio do recurso exportado.
`pages`	`all`	Metadados locais OpenDataBio de páginas do projeto.
`urls`	`all`	Lista local OpenDataBio de URLs associadas a um projeto.
`created_at`	`all`	Data e hora em que o registro foi criado no OpenDataBio.
`updated_at`	`all`	Data 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âmetro	Obrigatório	Descrição	Exemplo
`id`	Não	Id unico ou lista separada por virgula para filtrar/selecionar registros.	`1,2,3`
`bibreference`	Não	Id ou bibkey da referência.	`34`
`biocollection`	Não	Id, nome ou sigla da biocoleção.	`INPA`
`dataset`	Não	Id ou sigla do dataset.	`3 ou FOREST1`
`external`	Não	Flag para incluir ids externos (Tropicos, IPNI, etc.).	`1`
`fields`	Não	Lista separada por vírgulas dos campos a serem incluídos na resposta ou uma palavra especial all/simple/raw, padrão: simple	`id,scientificName ou all`
`job_id`	Não	Id do job para reutilizar affected_ids ou filtrar resultados.	`1024`
`level`	Não	Código ou string do nível taxonômico.	`210 ou species`
`limit`	Não	Quantidade maxima de registros retornados.	`100`
`location_root`	Não	Id/nome do local incluindo descendentes.	`Amazonas ou 10`
`name`	Não	Parametro generico de nome (taxon completo, local, export_name de trait, etc.).	`Ocotea guianensis`
`offset`	Não	A posição inicial do conjunto de registros a ser exportado. Usado em conjunto com `limit` para limitar os resultados.	`10000`
`person`	Não	Id/abreviação/nome/email de pessoa (aceita lista com \| ou ;).	`Silva, J.B.\|Costa, M.`
`project`	Não	Id ou sigla do projeto.	`PDBFF ou 2`
`root`	Não	Id raiz para consultas hierarquicas (taxon ou local).	`120`
`save_job`	Não	Se 1, salva a consulta como job para baixar depois via userjobs + get_file = 1	`1`
`taxon_root`	Não	Id/nome de taxon incluindo descendentes.	`Lauraceae`
`trait`	Não	Id ou export_name do trait para filtro.	`DBH`
`valid`	Não	Quando 1 retorna apenas nomes taxonômicos validos.	`1`
`vernacular`	Não	Id 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.

Campo	Perfis	Significado
`basisOfRecord`	`simple` / `all`	Coluna Darwin Core: valor basisOfRecord indicando o tipo geral de registro biológico.
`id`	`simple` / `all`	Identificador numérico interno do registro exportado nesta instalação OpenDataBio.
`uuid`	`simple` / `all`	UUID estável do registro exportado.
`scientificNameID`	`simple` / `all`	Coluna taxonômica Darwin Core: identificador estável do registro de nome taxonômico, formatado pelo OpenDataBio como `odb:{installation}:taxon:{uuid}`.
`scientificName`	`simple` / `all`	Coluna taxonômica Darwin Core: nome científico associado ao registro no momento da exportação.
`taxonRank`	`simple` / `all`	Coluna taxonômica Darwin Core: nível taxonômico do nome científico.
`scientificNameAuthorship`	`simple` / `all`	Coluna taxonômica Darwin Core: texto de autoria associado ao nome científico.
`namePublishedIn`	`simple` / `all`	Coluna taxonômica Darwin Core: referência bibliográfica na qual o nome taxonômico foi publicado.
`parentNameUsageID`	`simple` / `all`	Coluna taxonômica Darwin Core: identificador estável do táxon pai, formatado pelo OpenDataBio como `odb:{installation}:taxon:{uuid}`.
`parentNameUsage`	`simple` / `all`	Coluna taxonômica Darwin Core: nome do táxon pai na hierarquia taxonômica.
`family`	`simple` / `all`	Coluna taxonômica Darwin Core: família associada ao táxon exportado ou organismo identificado.
`higherClassification`	`simple` / `all`	Coluna taxonômica Darwin Core: caminho de classificação taxonômica superior do táxon.
`taxonRemarks`	`simple` / `all`	Coluna taxonômica Darwin Core: observações sobre o táxon.
`taxonomicStatus`	`simple` / `all`	Coluna taxonômica Darwin Core: status taxonômico do nome, como nome aceito ou sinônimo.
`acceptedNameUsage`	`simple` / `all`	Coluna taxonômica Darwin Core: nome científico aceito quando o nome exportado não é aceito.
`acceptedNameUsageID`	`simple` / `all`	Coluna taxonômica Darwin Core: identificador estável do nome taxonômico aceito, formatado pelo OpenDataBio como `odb:{installation}:taxon:{uuid}`.
`author_uuid`	`all`	UUID estável da pessoa ligada como autora de um nome taxonômico não publicado.
`bibreference_uuid`	`all`	UUID estável da referência bibliográfica ligada.
`parent_id`	`all`	Identificador numérico interno do registro pai em uma hierarquia.
`parent_uuid`	`all`	UUID estável do registro pai em uma hierarquia.
`senior_id`	`all`	Identificador numérico interno do nome taxonômico aceito ou sênior.
`externalKeys`	`all`	Identificadores 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âmetro	Obrigatório	Descrição	Exemplo
`id`	Não	Id unico ou lista separada por virgula para filtrar/selecionar registros.	`1,2,3`
`bibreference`	Não	Id ou bibkey da referência.	`34`
`categories`	Não	Lista JSON de categorias de trait com lang/rank/name/description.	`[{\"lang\":\"en\",\"rank\":1,\"name\":\"small\"}]`
`dataset`	Não	Id ou sigla do dataset.	`3 ou FOREST1`
`fields`	Não	Lista separada por vírgulas dos campos a serem incluídos na resposta ou uma palavra especial all/simple/raw, padrão: simple	`id,scientificName ou all`
`job_id`	Não	Id do job para reutilizar affected_ids ou filtrar resultados.	`1024`
`language`	Não	Id/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`
`limit`	Não	Quantidade maxima de registros retornados.	`100`
`name`	Não	Parametro generico de nome (taxon completo, local, export_name de trait, etc.).	`Ocotea guianensis`
`object_type`	Não	Tipo do objeto medido: Individual, Location, Taxon, Voucher ou Media.	`Individual`
`offset`	Não	A posição inicial do conjunto de registros a ser exportado. Usado em conjunto com `limit` para limitar os resultados.	`10000`
`save_job`	Não	Se 1, salva a consulta como job para baixar depois via userjobs + get_file = 1	`1`
`search`	Não	Parametro de busca de texto.	`Silva`
`tag`	Não	Tag/número/código do indivíduo.	`A-1234`
`taxon`	Não	Id ou nome canônico do taxon (lista aceita).	`Licaria cannela,Licaria armeniaca ou 456,789`
`taxon_root`	Não	Id/nome de taxon incluindo descendentes.	`Lauraceae`
`trait`	Não	Id ou export_name do trait para filtro.	`DBH`
`type`	Não	Parametro 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.

Campo	Perfis	Significado
`id`	`simple` / `all`	Identificador numérico interno do registro exportado nesta instalação OpenDataBio.
`uuid`	`simple` / `all`	UUID estável do registro exportado.
`parent_id`	`simple` / `all`	Identificador numérico interno do registro pai em uma hierarquia.
`parent_uuid`	`simple` / `all`	UUID estável do registro pai em uma hierarquia.
`type`	`simple` / `all`	Código ou rótulo local OpenDataBio do tipo do recurso exportado.
`typename`	`simple` / `all`	Nome legível local OpenDataBio de um tipo de trait.
`export_name`	`simple` / `all`	Nome de exportação estável local OpenDataBio de um trait, usado como chave pública em medições.
`unit`	`simple`	Unidade de medição local OpenDataBio configurada para um trait.
`range_min`	`simple` / `all`	Valor mínimo válido local OpenDataBio configurado para um trait quantitativo.
`range_max`	`simple` / `all`	Valor máximo válido local OpenDataBio configurado para um trait quantitativo.
`link_type`	`simple` / `all`	Tipo de objeto alvo local OpenDataBio permitido para um trait do tipo link.
`value_length`	`simple` / `all`	Número local OpenDataBio de valores esperados para um trait espectral.
`name`	`simple` / `all`	Nome local OpenDataBio do recurso exportado.
`description`	`simple` / `all`	Texto descritivo local OpenDataBio do recurso exportado.
`objects`	`simple` / `all`	Lista local OpenDataBio de tipos de objetos aos quais um trait pode se aplicar.
`measurementType`	`simple` / `all`	Coluna Darwin Core MeasurementOrFact: nome de exportação do trait ou tipo de medição representado.
`categories`	`simple` / `all`	Lista local OpenDataBio de categorias de trait, incluindo rótulos e descrições quando disponíveis.
`bibreference_id`	`all`	Identificador numérico interno da referência bibliográfica ligada.
`bibreference_uuid`	`all`	UUID estável da referência bibliográfica ligada.
`measurementUnit`	`all`	Coluna Darwin Core MeasurementOrFact: unidade associada ao valor da medição.
`measurementMethod`	`all`	Coluna Darwin Core MeasurementOrFact: método ou protocolo usado para obter a medição.
`MeasurementTypeBibkeys`	`all`	Lista local OpenDataBio de bibkeys que sustentam o tipo de medição do trait.
`TaggedWith`	`all`	Lista 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âmetro	Obrigatório	Descrição	Exemplo
`id`	Não	Id unico ou lista separada por virgula para filtrar/selecionar registros.	`1,2,3`
`fields`	Não	Lista separada por vírgulas dos campos a serem incluídos na resposta ou uma palavra especial all/simple/raw, padrão: simple	`id,scientificName ou all`
`individual`	Não	Id, uuid ou organismID do indivíduo.	`4521 ou 2ff0e884-3d33`
`job_id`	Não	Id do job para reutilizar affected_ids ou filtrar resultados.	`1024`
`limit`	Não	Quantidade maxima de registros retornados.	`100`
`location`	Não	Id ou nome do local.	`Parcela 25ha ou 55`
`location_root`	Não	Id/nome do local incluindo descendentes.	`Amazonas ou 10`
`offset`	Não	A posição inicial do conjunto de registros a ser exportado. Usado em conjunto com `limit` para limitar os resultados.	`10000`
`save_job`	Não	Se 1, salva a consulta como job para baixar depois via userjobs + get_file = 1	`1`
`taxon`	Não	Id ou nome canônico do taxon (lista aceita).	`Licaria cannela,Licaria armeniaca ou 456,789`
`taxon_root`	Não	Id/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.

Campo	Perfis	Significado
`id`	`simple` / `all`	Identificador numérico interno do registro exportado nesta instalação OpenDataBio.
`uuid`	`simple` / `all`	UUID estável do registro exportado.
`name`	`simple` / `all`	Nome local OpenDataBio do recurso exportado.
`languageName`	`simple` / `all`	Nome do idioma local OpenDataBio associado a um nome vernacular.
`notes`	`simple` / `all`	Notas locais OpenDataBio associadas ao recurso exportado.
`locationsList`	`simple` / `all`	Lista legível local OpenDataBio de localidades ligadas ao registro.
`taxonsList`	`simple` / `all`	Lista legível local OpenDataBio de táxons ligados ao registro.
`individualsList`	`simple` / `all`	Lista legível local OpenDataBio de indivíduos ligados ao registro.
`citationsArray`	`simple` / `all`	Lista estruturada local OpenDataBio de citações ligadas a um nome vernacular.
`languageCode`	`all`	Código de idioma local OpenDataBio associado a um nome vernacular.
`taxonsListArray`	`all`	Array estruturado local OpenDataBio de táxons ligados ao registro.
`individualsListArray`	`all`	Array estruturado local OpenDataBio de indivíduos ligados ao registro.
`locationsListArray`	`all`	Array estruturado local OpenDataBio de localidades ligadas ao registro.
`variantsList`	`all`	Lista legível local OpenDataBio de variantes vernaculares ligadas ao registro.
`variantsListArray`	`all`	Array estruturado local OpenDataBio de variantes vernaculares ligadas ao registro.
`createdBy`	`all`	Usuário ou pessoa local OpenDataBio que criou o registro.
`created_at`	`all`	Data e hora em que o registro foi criado no OpenDataBio.
`updated_at`	`all`	Data 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âmetro	Obrigatório	Descrição	Exemplo
`id`	Não	Id unico ou lista separada por virgula para filtrar/selecionar registros.	`1,2,3`
`bibreference`	Não	Id ou bibkey da referência.	`34`
`bibreference_id`	Não	Lista de ids de BibReference para filtrar vouchers.	`10,11`
`biocollection`	Não	Id, nome ou sigla da biocoleção.	`INPA`
`biocollection_id`	Não	Lista de ids de biocoleção para filtrar vouchers.	`1,5`
`collector`	Não	Coletor(es) id, abreviação, nome ou email. Separe múltiplos com \| ou ;, primeiro e o principal.	`Silva, J.B.\|Costa, M.`
`dataset`	Não	Id ou sigla do dataset.	`3 ou FOREST1`
`date_max`	Não	Filtra registros ate esta data (AAAA-MM-DD).	`2024-12-31`
`date_min`	Não	Filtra registros a partir desta data (AAAA-MM-DD).	`2020-01-01`
`fields`	Não	Lista separada por vírgulas dos campos a serem incluídos na resposta ou uma palavra especial all/simple/raw, padrão: simple	`id,scientificName ou all`
`individual`	Não	Id, uuid ou organismID do indivíduo.	`4521 ou 2ff0e884-3d33`
`job_id`	Não	Id do job para reutilizar affected_ids ou filtrar resultados.	`1024`
`limit`	Não	Quantidade maxima de registros retornados.	`100`
`location`	Não	Id ou nome do local.	`Parcela 25ha ou 55`
`location_root`	Não	Id/nome do local incluindo descendentes.	`Amazonas ou 10`
`main_collector`	Não	Booleano (1) para filtrar vouchers apenas pelo coletor principal.	`1`
`number`	Não	Número/código de coletor (voucher ou tag quando diferente).	`1234A`
`odbrequest_id`	Não	Filtra indivíduos vinculados a um request id.	`12`
`offset`	Não	A posição inicial do conjunto de registros a ser exportado. Usado em conjunto com `limit` para limitar os resultados.	`10000`
`person`	Não	Id/abreviação/nome/email de pessoa (aceita lista com \| ou ;).	`Silva, J.B.\|Costa, M.`
`project`	Não	Id ou sigla do projeto.	`PDBFF ou 2`
`save_job`	Não	Se 1, salva a consulta como job para baixar depois via userjobs + get_file = 1	`1`
`taxon`	Não	Id ou nome canônico do taxon (lista aceita).	`Licaria cannela,Licaria armeniaca ou 456,789`
`taxon_root`	Não	Id/nome de taxon incluindo descendentes.	`Lauraceae`
`trait`	Não	Id ou export_name do trait para filtro.	`DBH`
`vernacular`	Não	Id 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.

Campo	Perfis	Significado
`id`	`simple` / `all`	Identificador numérico interno do registro exportado nesta instalação OpenDataBio.
`uuid`	`simple` / `all`	UUID estável do registro exportado.
`individual_uuid`	`simple` / `all`	UUID estável do indivíduo ou organismo ligado.
`basisOfRecord`	`simple` / `all`	Coluna Darwin Core: valor basisOfRecord indicando o tipo geral de registro biológico.
`occurrenceID`	`simple` / `all`	Coluna 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.
`organismID`	`simple` / `all`	Coluna Darwin Core: identificador estável do organismo/indivíduo, formatado pelo OpenDataBio como `odb:{installation}:individual:{uuid}`.
`organismName`	`simple` / `all`	Coluna Darwin Core: rótulo legível do organismo ou registro de indivíduo.
`materialEntityID`	`simple` / `all`	Coluna 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}`.
`collectionCode`	`simple` / `all`	Coluna Darwin Core: código, sigla ou nome que identifica a biocoleção.
`catalogNumber`	`simple` / `all`	Coluna Darwin Core: número de catálogo ou número de acesso do voucher na biocoleção.
`typeStatus`	`simple` / `all`	Coluna Darwin Core: status nomenclatural de tipo de um voucher.
`recordedByMain`	`simple` / `all`	Coletor ou observador principal responsável pelo registro.
`recordNumber`	`simple` / `all`	Coluna Darwin Core: número de coleta ou observação.
`eventDate`	`simple` / `all`	Coluna Darwin Core: data ou intervalo em que ocorreu o evento de coleta, observação, captura da mídia ou ocorrência.
`recordedBy`	`simple` / `all`	Coluna Darwin Core: coletores ou observadores associados ao registro.
`scientificName`	`simple` / `all`	Coluna taxonômica Darwin Core: nome científico associado ao registro no momento da exportação.
`family`	`simple` / `all`	Coluna taxonômica Darwin Core: família associada ao táxon exportado ou organismo identificado.
`identificationQualifier`	`simple` / `all`	Coluna Darwin Core: qualificador que expressa incerteza ou condição da identificação.
`identifiedBy`	`simple` / `all`	Coluna Darwin Core: pessoa ou pessoas responsáveis pela identificação taxonômica.
`dateIdentified`	`simple` / `all`	Coluna Darwin Core: data em que a identificação taxonômica foi feita.
`identificationRemarks`	`simple` / `all`	Coluna Darwin Core: notas associadas à identificação taxonômica.
`location_id`	`simple` / `all`	Identificador numérico interno da localidade ligada.
`location_uuid`	`simple` / `all`	UUID estável da localidade ligada.
`locationName`	`simple` / `all`	Rótulo de localidade compatível com Darwin Core usado pelo OpenDataBio para a localidade associada ao registro.
`higherGeography`	`simple` / `all`	Coluna Darwin Core: contexto geográfico superior da localidade, como localidades parentais ou hierarquia administrativa.
`decimalLatitude`	`simple` / `all`	Coluna Darwin Core: latitude em graus decimais, quando coordenadas estão disponíveis para distribuição.
`decimalLongitude`	`simple` / `all`	Coluna Darwin Core: longitude em graus decimais, quando coordenadas estão disponíveis para distribuição.
`occurrenceRemarks`	`simple` / `all`	Coluna Darwin Core: observações sobre a ocorrência.
`datasetID`	`simple` / `all`	Coluna 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.
`datasetName`	`simple` / `all`	Coluna Darwin Core: nome ou título do dataset que governa o registro exportado.
`accessRights`	`simple` / `all`	Coluna 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.
`policyCode`	`simple` / `all`	Código compacto da política derivado da licença do dataset e das obrigações de uso.
`dataset_id`	`all`	Identificador numérico interno do dataset que governa o registro exportado.
`individual_id`	`all`	Identificador numérico interno do indivíduo ou organismo ligado.
`recordedDate`	`all`	Coluna legada OpenDataBio equivalente a Darwin Core eventDate. Mantida em exportações `all` por compatibilidade; prefira eventDate para interoperabilidade.
`scientificNameAuthorship`	`all`	Coluna taxonômica Darwin Core: texto de autoria associado ao nome científico.
`taxon_id`	`all`	Identificador numérico interno do nome taxonômico ligado.
`taxon_uuid`	`all`	UUID estável do nome taxonômico ligado.
`identification_id`	`all`	Identificador numérico interno da identificação taxonômica ligada ao registro.
`identification_uuid`	`all`	UUID estável da identificação taxonômica ligada ao registro.
`taxonPublishedStatus`	`all`	Status de publicação do nome taxonômico usado na identificação.
`genus`	`all`	Coluna taxonômica Darwin Core: gênero associado ao táxon exportado ou organismo identificado.
`georeferenceRemarks`	`all`	Coluna Darwin Core: notas descrevendo origem das coordenadas, incerteza ou detalhes de georreferenciamento.
`relatedLocations`	`all`	Outras localidades relacionadas ao registro, como parcelas, transectos ou localidades de ocorrência ligadas.
`policyUrl`	`all`	URL onde a política completa do dataset ou versão pode ser consultada.
`policySummary`	`all`	Resumo 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âmetro	Obrigatório	Descrição	Exemplo
`id`	Não	Id unico ou lista separada por virgula para filtrar/selecionar registros.	`1,2,3`
`fields`	Não	Lista separada por vírgulas dos campos a serem incluídos na resposta ou uma palavra especial all/simple/raw, padrão: simple	`id,scientificName ou all`
`get_file`	Não	Quando 1 com userjobs id, retorna o arquivo salvo.	`1`
`limit`	Não	Quantidade maxima de registros retornados.	`100`
`offset`	Não	A posição inicial do conjunto de registros a ser exportado. Usado em conjunto com `limit` para limitar os resultados.	`10000`
`status`	Não	Filtro 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.

Campo	Perfis	Significado
`id`	`simple` / `all`	Identificador numérico interno do registro exportado nesta instalação OpenDataBio.
`dispatcher`	`simple` / `all`	Classe do dispatcher ou tipo de job local OpenDataBio.
`status`	`simple` / `all`	Status local OpenDataBio de um job em segundo plano ou recurso exportado.
`percentage`	`simple` / `all`	Percentual de progresso local OpenDataBio de um job em segundo plano.
`created_at`	`simple` / `all`	Data e hora em que o registro foi criado no OpenDataBio.
`affected_ids_count`	`simple` / `all`	Contagem local OpenDataBio de registros afetados por um job em segundo plano.
`affected_model`	`simple` / `all`	Classe de modelo ou nome do modelo local OpenDataBio afetado por um job em segundo plano.
`updated_at`	`all`	Data e hora da última atualização do registro no OpenDataBio.
`affected_ids`	`all`	Lista local OpenDataBio de ids de registros afetados por um job em segundo plano.
`log`	`all`	Texto 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âmetro	Obrigatório	Descrição	Exemplo
`id`	Não	Id unico ou lista separada por virgula para filtrar/selecionar registros.	`1,2,3`
`description`	Não	Descrição em texto ou mapa de traducao.	`{\"en\":\"Leaf length\",\"pt-br\":\"Comprimento da folha\"}`
`fields`	Não	Lista separada por vírgulas dos campos a serem incluídos na resposta ou uma palavra especial all/simple/raw, padrão: simple	`id,scientificName ou all`
`individual`	Não	Id, uuid ou organismID do indivíduo.	`4521 ou 2ff0e884-3d33`
`language`	Não	Id/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`
`limit`	Não	Quantidade maxima de registros retornados.	`100`
`location`	Não	Id ou nome do local.	`Parcela 25ha ou 55`
`log_name`	Não	Filtro de activity log name.	`default`
`measurement`	Não	Filtro de atividade: id de measurement.	`55`
`offset`	Não	A posição inicial do conjunto de registros a ser exportado. Usado em conjunto com `limit` para limitar os resultados.	`10000`
`save_job`	Não	Se 1, salva a consulta como job para baixar depois via userjobs + get_file = 1	`1`
`subject`	Não	Filtro de atividade: tipo do subject (basename da classe).	`Individual`
`subject_id`	Não	Filtro de atividade: id do subject.	`12`
`taxon`	Não	Id ou nome canônico do taxon (lista aceita).	`Licaria cannela,Licaria armeniaca ou 456,789`
`taxon_root`	Não	Id/nome de taxon incluindo descendentes.	`Lauraceae`
`voucher`	Não	Id 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.

Campo	Perfis	Significado
`id`	`simple` / `all`	Identificador numérico interno do registro exportado nesta instalação OpenDataBio.
`log_name`	`simple` / `all`	Nome local OpenDataBio do log de atividade.
`description`	`simple` / `all`	Texto descritivo local OpenDataBio do recurso exportado.
`subject_type`	`simple` / `all`	Classe de modelo local OpenDataBio do objeto registrado em uma entrada de log de atividade.
`subject_name`	`simple` / `all`	Nome legível local OpenDataBio do objeto registrado em uma entrada de log de atividade.
`subject_id`	`simple` / `all`	Identificador numérico interno do objeto registrado em uma entrada de log de atividade.
`modified_by`	`simple` / `all`	Usuário local OpenDataBio que modificou o objeto do log de atividade.
`properties`	`simple` / `all`	Propriedades estruturadas locais OpenDataBio do log de atividade, geralmente codificadas como JSON.
`created_at`	`simple` / `all`	Data e hora em que o registro foi criado no OpenDataBio.
`updated_at`	`simple` / `all`	Data 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âmetro	Obrigatório	Descrição	Exemplo
`id`	Não	Id unico ou lista separada por virgula para filtrar/selecionar registros.	`1,2,3`
`dataset`	Não	Id ou sigla do dataset.	`3 ou FOREST1`
`fields`	Não	Lista separada por vírgulas dos campos a serem incluídos na resposta ou uma palavra especial all/simple/raw, padrão: simple	`id,scientificName ou all`
`job_id`	Não	Id do job para reutilizar affected_ids ou filtrar resultados.	`1024`
`language`	Não	Id/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`
`limit`	Não	Quantidade maxima de registros retornados.	`100`
`name`	Não	Parametro generico de nome (taxon completo, local, export_name de trait, etc.).	`Ocotea guianensis`
`offset`	Não	A posição inicial do conjunto de registros a ser exportado. Usado em conjunto com `limit` para limitar os resultados.	`10000`
`project`	Não	Id ou sigla do projeto.	`PDBFF ou 2`
`save_job`	Não	Se 1, salva a consulta como job para baixar depois via userjobs + get_file = 1	`1`
`search`	Não	Parametro de busca de texto.	`Silva`
`trait`	Não	Id 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.

Campo	Perfis	Significado
`id`	`simple` / `all`	Identificador numérico interno do registro exportado nesta instalação OpenDataBio.
`name`	`simple` / `all`	Nome local OpenDataBio do recurso exportado.
`description`	`simple` / `all`	Texto descritivo local OpenDataBio do recurso exportado.
`counts`	`all`	Contagens 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âmetro	Obrigatório	Descrição	Exemplo
`id`	Não	Id unico ou lista separada por virgula para filtrar/selecionar registros.	`1,2,3`
`brahms_level`	Não	Nivel da exportacao BRAHMS. Use individual para uma linha por individuo, ou voucher para uma linha por voucher ligado aos individuos encontrados.	`individual ou voucher`
`dataset`	Não	Id ou sigla do dataset.	`3 ou FOREST1`
`date_max`	Não	Filtra registros ate esta data (AAAA-MM-DD).	`2024-12-31`
`date_min`	Não	Filtra registros a partir desta data (AAAA-MM-DD).	`2020-01-01`
`fields`	Não	Lista separada por vírgulas dos campos a serem incluídos na resposta ou uma palavra especial all/simple/raw, padrão: simple	`id,scientificName ou all`
`habitattxt_traits`	Não	Lista 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_header`	Não	Booleano, 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_vernaculars`	Não	Quando 1, o vernacular do BRAHMS tambem inclui nomes ligados ao taxon do individuo.	`0`
`include_vernaculars`	Não	Quando 1, inclui nomes vernaculares na saida BRAHMS.	`1`
`include_voucher_individuals`	Não	Para exportacoes BRAHMS no nivel individual com filtro de dataset, inclui individuos fora do dataset quando eles possuem vouchers no dataset solicitado.	`1`
`job_id`	Não	Id do job para reutilizar affected_ids ou filtrar resultados.	`1024`
`lang`	Não	Codigo/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`
`limit`	Não	Quantidade maxima de registros retornados.	`100`
`location`	Não	Id ou nome do local.	`Parcela 25ha ou 55`
`location_root`	Não	Id/nome do local incluindo descendentes.	`Amazonas ou 10`
`locnotes_traits`	Não	Lista 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_header`	Não	Booleano, 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_dataset`	Não	Lista de ids/nomes de datasets usada para limitar as medicoes resumidas nas descricoes BRAHMS.	`Flora-INPA`
`odbrequest_id`	Não	Filtra indivíduos vinculados a um request id.	`12`
`offset`	Não	A posição inicial do conjunto de registros a ser exportado. Usado em conjunto com `limit` para limitar os resultados.	`10000`
`person`	Não	Id/abreviação/nome/email de pessoa (aceita lista com \| ou ;).	`Silva, J.B.\|Costa, M.`
`plantdesc_traits`	Não	Lista 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_header`	Não	Booleano, 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`
`project`	Não	Id ou sigla do projeto.	`PDBFF ou 2`
`save_job`	Não	Se 1, salva a consulta como job para baixar depois via userjobs + get_file = 1	`1`
`tag`	Não	Tag/número/código do indivíduo.	`A-1234`
`taxon`	Não	Id ou nome canônico do taxon (lista aceita).	`Licaria cannela,Licaria armeniaca ou 456,789`
`taxon_root`	Não	Id/nome de taxon incluindo descendentes.	`Lauraceae`
`trait`	Não	Id ou export_name do trait para filtro.	`DBH`
`vernacular`	Não	Id 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.

Campo	Perfis	Significado
`odbUuid`	`simple` / `all`	Coluna de exportação BRAHMS/INPA: UUID OpenDataBio do registro fonte exportado.
`collector`	`simple` / `all`	Coluna de exportação BRAHMS/INPA para nome ou abreviação do coletor principal.
`number`	`simple` / `all`	Número de registro, coleta ou BRAHMS; o significado exato depende do endpoint.
`addcoll`	`simple` / `all`	Coluna de exportação BRAHMS/INPA para coletores adicionais.
`colldd`	`simple` / `all`	Coluna de exportação BRAHMS/INPA para dia da coleta.
`collmm`	`simple` / `all`	Coluna de exportação BRAHMS/INPA para mês da coleta.
`collyy`	`simple` / `all`	Coluna de exportação BRAHMS/INPA para ano da coleta.
`family`	`simple` / `all`	Coluna taxonômica Darwin Core: família associada ao táxon exportado ou organismo identificado.
`genus`	`simple` / `all`	Coluna taxonômica Darwin Core: gênero associado ao táxon exportado ou organismo identificado.
`sp1`	`simple` / `all`	Coluna de exportação BRAHMS/INPA para o primeiro epíteto específico.
`sp2`	`simple` / `all`	Coluna de exportação BRAHMS/INPA para o segundo epíteto ou nome infraespecífico.
`detby`	`simple` / `all`	Coluna de exportação BRAHMS/INPA para a pessoa que identificou o espécime ou indivíduo.
`country`	`simple` / `all`	Nome ou código do país associado a uma localidade, coleção ou linha de exportação BRAHMS.
`majorarea`	`simple` / `all`	Coluna de exportação BRAHMS/INPA para área geográfica principal.
`minorarea`	`simple` / `all`	Coluna de exportação BRAHMS/INPA para área geográfica secundária.
`gazetteer`	`simple` / `all`	Coluna de exportação BRAHMS/INPA para gazetteer ou localidade nomeada.
`locnotes`	`simple` / `all`	Coluna de exportação BRAHMS/INPA para notas da localidade, localidades relacionadas e informação de posição local.
`habitattxt`	`simple` / `all`	Coluna de exportação BRAHMS/INPA para texto de habitat, geralmente derivado de medições da localidade atual quando disponíveis.
`lat`	`simple` / `all`	Coluna de exportação BRAHMS/INPA: valor de latitude formatado para a tabela de intercâmbio BRAHMS.
`NS`	`simple` / `all`	Coluna de exportação BRAHMS/INPA indicando se a latitude está ao norte ou ao sul.
`long`	`simple` / `all`	Coluna de exportação BRAHMS/INPA: valor de longitude formatado para a tabela de intercâmbio BRAHMS.
`EW`	`simple` / `all`	Coluna de exportação BRAHMS/INPA indicando se a longitude está a leste ou oeste.
`llunit`	`simple` / `all`	Coluna de exportação BRAHMS/INPA que descreve a unidade ou formato de latitude/longitude.
`alt`	`simple` / `all`	Coluna de exportação BRAHMS/INPA para elevação ou altitude.
`plantdesc`	`simple` / `all`	Coluna de exportação BRAHMS/INPA para descrição da planta, derivada de medições e notas do indivíduo ou voucher.
`vernacular`	`simple` / `all`	Coluna de exportação BRAHMS/INPA para nomes vernaculares.
`project`	`simple` / `all`	Coluna de exportação BRAHMS/INPA para nome, sigla ou código do projeto.
`campo`	`all`	Coluna de exportação BRAHMS/INPA usada por fluxos locais para identificar o campo ou contexto fonte.
`accession`	`all`	Coluna de exportação BRAHMS/INPA para valor de acesso ou accession de coleção.
`prefix`	`all`	Coluna de exportação BRAHMS/INPA para prefixo do número de coleta.
`suffix`	`all`	Coluna de exportação BRAHMS/INPA para sufixo do número de coleta.
`initial`	`all`	Coluna de exportação BRAHMS/INPA para iniciais do coletor ou campo local de iniciais.
`detstatus`	`all`	Coluna de exportação BRAHMS/INPA para status da determinação.
`rank1`	`all`	Coluna de exportação BRAHMS/INPA para categoria infraespecífica.
`detdd`	`all`	Coluna de exportação BRAHMS/INPA para dia da identificação.
`detmm`	`all`	Coluna de exportação BRAHMS/INPA para mês da identificação.
`detyy`	`all`	Coluna de exportação BRAHMS/INPA para ano da identificação.
`alt1`	`all`	Coluna de exportação BRAHMS/INPA para valor secundário de elevação ou altitude.
`dups`	`all`	Coluna 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âmetro	Obrigatório	Descrição	Exemplo
`id`	Não	Id unico ou lista separada por virgula para filtrar/selecionar registros.	`1,2,3`
`biocollection`	Não	Id, nome ou sigla da biocoleção.	`INPA`
`date_max`	Não	Filtra registros ate esta data (AAAA-MM-DD).	`2024-12-31`
`date_min`	Não	Filtra registros a partir desta data (AAAA-MM-DD).	`2020-01-01`
`fields`	Não	Lista separada por vírgulas dos campos a serem incluídos na resposta ou uma palavra especial all/simple/raw, padrão: simple	`id,scientificName ou all`
`identification_id`	Não	Id 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`
`individual`	Não	Id, uuid ou organismID do indivíduo.	`4521 ou 2ff0e884-3d33`
`individual_id`	Não	Ids de indivíduos para ocorrências.	`12,55,90`
`job_id`	Não	Id do job para reutilizar affected_ids ou filtrar resultados.	`1024`
`limit`	Não	Quantidade maxima de registros retornados.	`100`
`offset`	Não	A posição inicial do conjunto de registros a ser exportado. Usado em conjunto com `limit` para limitar os resultados.	`10000`
`person`	Não	Id/abreviação/nome/email de pessoa (aceita lista com \| ou ;).	`Silva, J.B.\|Costa, M.`
`save_job`	Não	Se 1, salva a consulta como job para baixar depois via userjobs + get_file = 1	`1`
`source`	Não	Rótulo de origem para registros gerados ou importados.	`api`
`taxon`	Não	Id ou nome canônico do taxon (lista aceita).	`Licaria cannela,Licaria armeniaca ou 456,789`
`taxon_root`	Não	Id/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.

Campo	Perfis	Significado
`id`	`simple` / `all`	Identificador numérico interno do registro exportado nesta instalação OpenDataBio.
`identification_id`	`simple` / `all`	Identificador numérico interno da identificação taxonômica ligada ao registro.
`identification_uuid`	`simple` / `all`	UUID estável da identificação taxonômica ligada ao registro.
`individual_id`	`simple` / `all`	Identificador numérico interno do indivíduo ou organismo ligado.
`individual_uuid`	`simple` / `all`	UUID estável do indivíduo ou organismo ligado.
`organismID`	`simple` / `all`	Coluna Darwin Core: identificador estável do organismo/indivíduo, formatado pelo OpenDataBio como `odb:{installation}:individual:{uuid}`.
`organismName`	`simple` / `all`	Coluna Darwin Core: rótulo legível do organismo ou registro de indivíduo.
`taxon_id`	`simple` / `all`	Identificador numérico interno do nome taxonômico ligado.
`taxon_uuid`	`simple` / `all`	UUID estável do nome taxonômico ligado.
`scientificName`	`simple` / `all`	Coluna taxonômica Darwin Core: nome científico associado ao registro no momento da exportação.
`family`	`simple` / `all`	Coluna taxonômica Darwin Core: família associada ao táxon exportado ou organismo identificado.
`identificationQualifier`	`simple` / `all`	Coluna Darwin Core: qualificador que expressa incerteza ou condição da identificação.
`identifiedBy`	`simple` / `all`	Coluna Darwin Core: pessoa ou pessoas responsáveis pela identificação taxonômica.
`dateIdentified`	`simple` / `all`	Coluna Darwin Core: data em que a identificação taxonômica foi feita.
`identificationBiocollection`	`simple` / `all`	Biocoleção usada como referência para a identificação, quando aplicável.
`identificationBiocollectionReference`	`simple` / `all`	Número de catálogo ou referência na biocoleção usada para identificação.
`identificationRemarks`	`simple` / `all`	Coluna Darwin Core: notas associadas à identificação taxonômica.
`replaced_at`	`simple` / `all`	Data ou timestamp em que uma linha de histórico de identificação foi substituída.
`replacedByName`	`simple` / `all`	Nome local OpenDataBio da identificação que substituiu esta linha de histórico de identificação.
`source`	`simple` / `all`	Rótulo local OpenDataBio da fonte do registro ou linha de histórico de identificação.
`scientificNameAuthorship`	`all`	Coluna taxonômica Darwin Core: texto de autoria associado ao nome científico.
`taxonPublishedStatus`	`all`	Status de publicação do nome taxonômico usado na identificação.
`genus`	`all`	Coluna taxonômica Darwin Core: gênero associado ao táxon exportado ou organismo identificado.
`identifiers`	`all`	Lista local OpenDataBio de pessoas responsáveis por uma identificação taxonômica.
`modifier`	`all`	Código local OpenDataBio de qualificador/modificador de identificação armazenado em uma linha de histórico de identificação.
`date`	`all`	Data local OpenDataBio associada ao registro exportado; o evento exato depende do endpoint.
`biocollection_id`	`all`	Identificador numérico interno da biocoleção ligada.
`biocollection_uuid`	`all`	UUID estável da biocoleção ligada.
`replaced_by`	`all`	Identificador numérico interno da linha de histórico de identificação que substituiu esta linha.
`source_id`	`all`	Identificador local OpenDataBio do registro fonte ou processo fonte.
`source_payload`	`all`	Conteúdo estruturado local OpenDataBio vindo do processo fonte, geralmente codificado como JSON.
`created_at`	`all`	Data e hora em que o registro foi criado no OpenDataBio.
`updated_at`	`all`	Data e hora da última atualização do registro no OpenDataBio.

3 - Inserir dados - POST

Como importar dados ao OpenDataBio usando a API

Importando dados

O pacote OpenDataBio é um cliente para esta API e permite importar dados a partir de objetos da linguagem R (exemplos);
Dados podem ser importados via interface web através de planilhas, onde os nomes das colunas são Parâmetros POST listados nesta página
O token de autenticação é necessário para solicitações POST
Importações podem ser executadas como UserJobs em segundo plano. Uma tarefa concluída ainda pode conter avisos ou erros por registro; confira os resultados estruturados.

O antigo endpoint de importação de atividades foi removido. Use o endpoint identification-histories para o histórico biológico de identificações. O log de atividades da aplicação é uma trilha de auditoria, não um histórico biológico importável.

Dados estruturados personalizados no campo `notes`

No campo notes de qualquer modelo, você pode armazenar texto simples ou um texto formatado como um objeto JSON contendo dados estruturados. A opção Json permite que você armazene dados estruturados personalizados em qualquer modelo que tenha o campo notes. Esses dados não serão validados pelo OpenDataBio e a padronização de tags e valores depende de você.

Endpoints POST

bibreferences (POST)

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

Parâmetro	Obrigatório	Descrição	Exemplo
`bibtex`	Não	Referência em formato BibTeX. (Provide doi or bibtex.)	`@article{meuchave,...}`
`doi`	Não	Número ou URL de DOI. (Provide doi or bibtex.)	`10.1234/abcd.2020.1`

biocollections (POST)

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

Parâmetro	Obrigatório	Descrição	Exemplo
`acronym`	Sim	Sigla da biocoleção.	`INPA`
`name`	Sim	Parametro generico de nome (taxon completo, local, export_name de trait, etc.).	`Ocotea guianensis`

individuals (POST)

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

Parâmetro	Obrigatório	Descrição	Exemplo
`altitude`	Não	Altitude em metros.	`75`
`angle`	Não	Azimute em graus a partir do ponto de referência.	`45`
`biocollection`	Não	Id, nome ou sigla da biocoleção.	`INPA`
`biocollection_number`	Não	Número/código do voucher na biocoleção.	`12345`
`biocollection_type`	Não	Código ou nome do tipo nomenclatural.	`Holotype ou 2`
`collector`	Sim	Coletor(es) id, abreviação, nome ou email. Separe múltiplos com \| ou ;, primeiro e o principal.	`Silva, J.B.\|Costa, M.`
`dataset`	Sim	Id ou sigla do dataset.	`3 ou FOREST1`
`date`	Sim	Data (AAAA-MM-DD) ou data incompleta (ex. 1888-05-NA) ou array com year/month/day. (At least the year must be provided.)	`2024-05-20 ou {\"year\":1888,\"month\":5}`
`distance`	Não	Distância ao ponto de referência em metros.	`12.5`
`identification_based_on_biocollection`	Não	Nome/id da biocoleção usada como referência de identificacao.	`INPA`
`identification_based_on_biocollection_number`	Não	O catalogNumber do voucher usado como referência.	`8765`
`identification_date`	Não	Data da identificacao (completa ou incompleta).	`2023-06-NA`
`identification_individual`	Não	Id/organismID do indivíduo cuja identificacao sera reaproveitada.	`3245 ou REC-123`
`identification_notes`	Não	Notas da identificacao.	`Conferido em microscopia`
`identifier`	Não	Pessoa(s) responsavel(is) pela identificacao; aceita id, abreviação, nome ou email; use \| ou ;. Obrigatório quando taxon é informado. Use identifier=collector para usar o valor de collector informado no mesmo registro, ou identifier=keep em updates para preservar o identificador existente.	`A.Costa\|B.Lima ou collector ou keep`
`latitude`	Não	Latitude em graus decimais (negativo para sul). (Required when location is not provided.)	`-3.101`
`location`	Não	Id ou nome do local. (Required when latitude/longitude are not provided.)	`Parcela 25ha ou 55`
`location_date_time`	Não	Data ou data+hora do evento de localização/ocorrência. (Required when adding multiple locations or when different from individual date.)	`2023-08-14 12:30:00`
`location_notes`	Não	Notas da ocorrência/local.	`Perto do marco 10`
`longitude`	Não	Longitude em graus decimais (negativo para oeste). (Required when location is not provided.)	`-60.12`
`modifier`	Não	Código/nome do modificador de identificacao (s.s.=1, s.l.=2, cf.=3, aff.=4, vel aff.=5).	`3`
`notes`	Não	Notas em texto ou JSON.	`{\"expedition\":\"2024-01\",\"tag\":\"P1\"}`
`tag`	Sim	Tag/número/código do indivíduo.	`A-1234`
`taxon`	Não	Id ou nome canônico do taxon (lista aceita).	`Licaria cannela,Licaria armeniaca ou 456,789`
`x`	Não	Coordenada cartesiana do indivívudo na parcela ou transecto, a partir da origem	`10`
`y`	Não	Coordenada cartesiana do indivívudo na parcela ou transecto. Quando transecto, valores positivos (lado direito), valores negativos (lado esquerdo), a partir da origem	`5.1`

individual-locations (POST)

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

Parâmetro	Obrigatório	Descrição	Exemplo
`altitude`	Não	Altitude em metros.	`75`
`angle`	Não	Azimute em graus a partir do ponto de referência.	`45`
`distance`	Não	Distância ao ponto de referência em metros.	`12.5`
`individual`	Sim	Id, uuid ou organismID do indivíduo.	`4521 ou 2ff0e884-3d33`
`latitude`	Não	Latitude em graus decimais (negativo para sul). (Required when location is not provided.)	`-3.101`
`location`	Não	Id ou nome do local. (Required when latitude/longitude are not provided.)	`Parcela 25ha ou 55`
`location_date_time`	Sim	Data ou data+hora do evento de localização/ocorrência.	`2023-08-14 12:30:00`
`location_notes`	Não	Notas da ocorrência/local.	`Perto do marco 10`
`longitude`	Não	Longitude em graus decimais (negativo para oeste). (Required when location is not provided.)	`-60.12`
`x`	Não	Coordenada cartesiana do indivívudo na parcela ou transecto, a partir da origem	`10`
`y`	Não	Coordenada cartesiana do indivívudo na parcela ou transecto. Quando transecto, valores positivos (lado direito), valores negativos (lado esquerdo), a partir da origem	`5.1`

locations (POST)

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

Parâmetro	Obrigatório	Descrição	Exemplo
`adm_level`	Sim	Código do nível administrativo do local (ex. 100=parcela, 10=país).	`100`
`altitude`	Não	Altitude em metros.	`75`
`azimuth`	Não	Azimute (graus) usado para montar geometria de plot/transecto quando o local e POINT.	`90`
`datum`	Não	Datum/projecao espacial.	`EPSG:4326-WGS 84`
`geojson`	Não	Feature GeoJSON de entrada, com geometria e pelo menos name + adm_level nas properties. Ela é convertida para a geometria da localidade e não é armazenada em coluna locations.geojson. (Provide geojson, geom or lat+long.)	`{\"type\":\"Feature\",\"properties\":{\"name\":\"Plot A\",\"adm_level\":100},\"geometry\":{...}}`
`geom`	Não	Geometria WKT (POINT, LINESTRING, POLYGON, MULTIPOLYGON). (Provide geojson, geom or lat+long.)	`POLYGON((-60 -3,-60.1 -3,-60.1 -3.1,-60 -3.1,-60 -3))`
`ismarine`	Não	Flag para aceitar locais marinhos fora de poligonos de país.	`1`
`lat`	Não	Latitude em graus decimais (negativo para sul). (Provide geojson, geom or lat+long.)	`-3.101`
`long`	Não	Longitude em graus decimais (negativo para oeste). (Provide geojson, geom or lat+long.)	`-60.12`
`name`	Sim	Parametro generico de nome (taxon completo, local, export_name de trait, etc.).	`Ocotea guianensis`
`notes`	Não	Notas em texto ou JSON.	`{\"expedition\":\"2024-01\",\"tag\":\"P1\"}`
`parent`	Não	Id ou nome do pai (taxon ou local).	`Lauraceae ou 210`
`startx`	Não	Coordenada X inicial de subparcela em relação ao plot pai.	`5.5`
`starty`	Não	Coordenada Y inicial de subparcela em relação ao plot pai.	`10.0`
`x`	Não	Dimensão X para plots ou comprimento transecto	`100`
`y`	Não	Dimensão Y para plots ou buffer para transectos (PELD)	`40`

locations-validation (POST)

Valida coordenadas com locais registrados (POST).

Parâmetro	Obrigatório	Descrição	Exemplo
`latitude`	Sim	Latitude em graus decimais (negativo para sul).	`-3.101`
`longitude`	Sim	Longitude em graus decimais (negativo para oeste).	`-60.12`

measurements (POST)

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

Parâmetro	Obrigatório	Descrição	Exemplo
`bibreference`	Não	Id ou bibkey da referência.	`34`
`dataset`	Sim	ID/nome do dataset onde a medição será armazenada; se omitido, usa o dataset padrão do usuário autenticado se existir.	`3 ou FOREST1`
`date`	Sim	Data da medição; aceita YYYY-MM-DD, YYYY-MM, YYYY, ou campos em array ano-mês-dia (date_year/date_month/date_day).	`2024-05-10 ou 2024-05 ou {"year":2024,"month":5}`
`duplicated`	Não	Número sequencial para permitir medidas duplicadas do mesmo trait/objeto/data.	`2 para o segundo registro, 3 para o terceiro e assim por diante`
`link_id`	Não	Obrigatório para traços do tipo LINK: ID do objeto ligado (ex.: ID do Taxon). (Required when trait type is Link.)	`55`
`location`	Não	Id ou nome do local.	`Parcela 25ha ou 55`
`notes`	Não	Opcional. Texto livre ou notas em JSON armazenadas com a medição.	`{"method":"caliper"}`
`object_id`	Sim	Obrigatório. ID numérico do objeto medido (Individual, Location, Taxon, Voucher, Media). Alias: measured_id.	`4521`
`object_type`	Sim	Obrigatório quando não fornecido no header. Nome da classe ou FQCN do objeto medido (Individual, Location, Taxon, Voucher, Media). Alias: measured_type.	`Individual`
`parent_measurement`	Não	Quando a variável depende de outra medição, informe o ID da medição pai para o mesmo objeto e data.	`3001`
`person`	Sim	Id/abreviação/nome/email de pessoa (aceita lista com \| ou ;).	`Silva, J.B.\|Costa, M.`
`trait_id`	Sim	Obrigatório. ID ou export_name da variável medida. Alias: também aceita chave “trait”.	`treeDbh ou 12`
`value`	Não	Valor(es) da medida; depende do tipo do trait: QUANT_INTEGER (0) = número inteiro; QUANT_REAL (1) = número decimal, ponto como separator; CATEGORICAL or ORDINAL (2/4) = uma única categoria, pode ser o id ou o nome; CATEGORICAL_MULTIPLE (3) = lista de ids ou nomes de categorias separadas por \| ; ou ,; TEXT (5) = um texto livre; COLOR (6) = cor em formato hex #A1B2C3 or #ABC; LINK (7) = enviar o link_id do object (value pode ser vazio neste caso, ou um número); SPECTRAL (8) = valores de absorbânica/reflectância separados por ponto-e-vírgula (;) com mesmo número de valores especificados na definição da variável; GENEBANK (9) = código alfanumérico do accesso do registro no GenBank (ele é validado contra o NCBI). (Required unless trait type is Link.)	`QUANT_REAL: 23.4 \| CATEGORICAL: 15 ou Morta \| CATEGORICAL_MULTIPLE: 12;14 ou Simples;Composta \| SPECTRAL: 0.12;0.11;0.10`

media (POST)

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

Parâmetro	Obrigatório	Descrição	Exemplo
`collector`	Não	Coletor(es) id, abreviação, nome ou email. Separe múltiplos com \| ou ;, primeiro e o principal.	`Silva, J.B.\|Costa, M.`
`dataset`	Não	Id ou sigla do dataset.	`3 ou FOREST1`
`date`	Não	Data (AAAA-MM-DD) ou data incompleta (ex. 1888-05-NA) ou array com year/month/day.	`2024-05-20 ou {\"year\":1888,\"month\":5}`
`filename`	Sim	Nome exato do arquivo de mídia dentro do ZIP ao importar mídia.	`IMG_0001.jpg`
`latitude`	Não	Latitude em graus decimais (negativo para sul).	`-3.101`
`license`	Não	Licenca publica para mídia (CC0, CC-BY, CC-BY-SA, etc.).	`CC-BY-SA`
`location`	Não	Id ou nome do local.	`Parcela 25ha ou 55`
`longitude`	Não	Longitude em graus decimais (negativo para oeste).	`-60.12`
`notes`	Não	Notas em texto ou JSON.	`{\"expedition\":\"2024-01\",\"tag\":\"P1\"}`
`object_id`	Sim	ID do objeto ao qual a mídia pertence (Indivíduo, Local, Táxon, Voucher).	`4521`
`object_type`	Sim	O tipo de objeto ao qual a mídia pertence, um dos seguintes: Individual, Local, Táxon ou Voucher.	`Individual`
`project`	Não	Id ou sigla do projeto.	`PDBFF ou 2`
`tags`	Não	Ids ou nomes de tags para mídia ou filtros (use \| ou ;).	`flower\|leaf`
`title_en`	Não	Titulo da mídia em ingles.	`Leaf detail`
`title_pt`	Não	Titulo da mídia em portugues.	`Detalhe da folha`

persons (POST)

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

Parâmetro	Obrigatório	Descrição	Exemplo
`abbreviation`	Não	Abreviação padrão de pessoa ou coleção.	`Silva, J.B.`
`biocollection`	Não	Id, nome ou sigla da biocoleção.	`INPA`
`email`	Não	Endereco de email.	`user@example.org`
`full_name`	Sim	Nome completo da pessoa.	`Joao Silva`
`institution`	Não	Instituicao associada a pessoa.	`INPA`

taxons (POST)

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

Parâmetro	Obrigatório	Descrição	Exemplo
`author`	Não	String opcional de autoria para nomes publicados. Em nomes publicados costuma ser preenchida automaticamente pela API. Para nomes não publicados, mantenha author nulo e use author_id/person.	`Nees`
`author_id`	Não	Alternativa a person para nomes não publicados. Obrigatório para nomes não publicados quando person não for enviado. (Required for unpublished names (or use person).)	`25`
`bibkey`	Não	Id da referência bibliográfica ou bibkey, opcional, para resolver bibreference_id. Em nomes publicados, dados bibliográficos vindos da API também podem preencher o registro.	`ducke1953 ou 34`
`bibreference`	Não	Id ou bibkey da referência.	`34`
`enforceValid`	Não	Override booleano opcional para nomes publicados. Use quando você enviar valid=true e quiser sobrescrever um resultado da API que marca o nome como inválido e define um nome sênior.	`1 ou true`
`gbif`	Não	Id opcional do GBIF. No POST ele é armazenado como informado; não há validação adicional por API para esse valor explícito.	`28792`
`indexfungorum`	Não	Identificador Index Fungorum de um táxon.	`IF123456`
`ipni`	Não	Id opcional do IPNI. No POST ele é armazenado como informado; não há validação adicional por API para esse valor explícito.	`123456-1`
`level`	Não	Opcional para nomes publicados porque a API pode defini-lo. Obrigatório para nomes não publicados exceto quando o nome validado tem duas palavras, caso em que será importado como species. Aceita código numérico do rank ou nome do rank como species/subspecies/clade.	`210 ou species`
`mobot`	Não	Id opcional do Tropicos/MOBOT. No POST ele é armazenado como informado; não há validação adicional por API para esse valor explícito.	`25509881`
`mycobank`	Não	Id opcional do MycoBank. No POST ele é armazenado como informado; não há validação adicional por API para esse valor explícito.	`MB123456`
`name`	Sim	Nome do táxon, obrigatório. Para nomes publicados, o POST consulta APIs nomenclaturais externas e pode normalizar nome, parent, rank, valid, senior_id, author, bibreference e ids externos. Para nomes não publicados, informe author_id/person e parent; level é obrigatório exceto quando o nome validado tem duas palavras, caso em que será importado como species.	`Ocotea guianensis ou Inga sp. 1`
`parent`	Não	Opcional para nomes publicados, obrigatório para nomes não publicados. Aceita id do táxon pai ou nome científico. Para nomes publicados, se a API encontrar um pai diferente, o pai informado é mantido e um aviso é registrado no log. (Required for unpublished names.)	`Ocotea ou 120`
`parent_id`	Não	Id do pai para consultas hierarquicas.	`210`
`parent_name`	Não	Nome alternativo do táxon pai usado em importações e atualizações de táxons.	`Ocotea`
`person`	Não	Use apenas para nomes não publicados. Aceita id, abreviação, nome completo ou email da pessoa e resolve para author_id. Quando presente, o registro é tratado como não publicado e a busca em API não é usada. (Required for unpublished names (or use author_id).)	`25 ou Pilco, M.V.`
`senior`	Não	Id ou nome do táxon sênior aceito usado ao importar um táxon inválido.	`Ocotea guianensis`
`senior_id`	Não	Id opcional do nome aceito quando o táxon importado é inválido. O táxon sênior deve existir, ser válido e ser publicado.	`345`
`valid`	Não	Booleano opcional. Quando omitido no POST, a validade é inferida a partir de senior/senior_id ou do resultado da API. Nomes inválidos são permitidos tanto para táxons publicados quanto não publicados. Se você enviar valid=true para um nome publicado e a API disser que o nome é inválido, a importação é rejeitada, a menos que enforceValid=true também seja enviado.	`1 ou 0`
`zoobank`	Não	Id opcional do ZooBank. No POST ele é armazenado como informado; não há validação adicional por API para esse valor explícito.	`urn:lsid:zoobank.org:act:XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX`

traits (POST)

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

Parâmetro	Obrigatório	Descrição	Exemplo
`bibreference`	Não	Id ou bibkey da referência.	`34`
`categories`	Não	Lista JSON de categorias de trait com lang/rank/name/description. (Required for categorical and ordinal traits.)	`[{\"lang\":\"en\",\"rank\":1,\"name\":\"small\"}]`
`description`	Sim	Descrição em texto ou mapa de traducao.	`{\"en\":\"Leaf length\",\"pt-br\":\"Comprimento da folha\"}`
`export_name`	Sim	Nome de exportação unico do trait.	`DBH`
`link_type`	Não	Classe alvo do trait tipo Link (ex. Taxon). (Required for Link traits.)	`Taxon`
`name`	Sim	Parametro generico de nome (taxon completo, local, export_name de trait, etc.).	`Ocotea guianensis`
`objects`	Sim	Objetos alvo do trait (separados por virgula).	`Individual,Voucher`
`parent`	Não	ID da característica pai ou nome de exportação; quando definido, as medições desta característica também devem incluir uma medição para a característica pai.	`woodDensity`
`range_max`	Não	Valor máximo permitido para traits quantitativos.	`999.9`
`range_min`	Não	Valor mínimo permitido para traits quantitativos.	`0.01`
`tags`	Não	Ids ou nomes de tags para mídia ou filtros (use \| ou ;).	`flower\|leaf`
`type`	Sim	Parametro generico type (código do trait ou tipo de vernacular: use/generic/etimology).	`use ou 10`
`unit`	Não	(Required for quantitative and spectral traits.)	—
`value_length`	Não	Número de valores para trait espectral. (Required for spectral traits.)	`1024`
`wavenumber_max`	Não	Número de onda máximo para traits espectrais. (Required for spectral traits.)	`25000`
`wavenumber_min`	Não	Número de onda mínimo para traits espectrais. (Required for spectral traits.)	`4000`

vernaculars (POST)

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

Parâmetro	Obrigatório	Descrição	Exemplo
`citations`	Não	Lista de citacoes (texto + bibreference) para vernaculares.	`[{\"citation\":\"Silva 2020\",\"bibreference\":12}]`
`individuals`	Não	Lista de ids/nomes de indivíduos para vincular vernacular.	`12\|23\|45`
`language`	Sim	Id/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`
`name`	Sim	Parametro generico de nome (taxon completo, local, export_name de trait, etc.).	`Ocotea guianensis`
`notes`	Não	Notas em texto ou JSON.	`{\"expedition\":\"2024-01\",\"tag\":\"P1\"}`
`parent`	Não	Id ou nome do pai (taxon ou local).	`Lauraceae ou 210`
`taxons`	Não	Lista de ids/nomes de taxon (para vernacular).	`Euterpe edulis\|Ocotea guianensis`
`type`	Não	Parametro generico type (código do trait ou tipo de vernacular: use/generic/etimology).	`use ou 10`

vouchers (POST)

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

Parâmetro	Obrigatório	Descrição	Exemplo
`biocollection`	Sim	Id, nome ou sigla da biocoleção.	`INPA`
`biocollection_number`	Não	Número/código do voucher na biocoleção.	`12345`
`biocollection_type`	Não	Código ou nome do tipo nomenclatural.	`Holotype ou 2`
`collector`	Não	Coletor(es) id, abreviação, nome ou email. Separe múltiplos com \| ou ;, primeiro e o principal.	`Silva, J.B.\|Costa, M.`
`dataset`	Não	Id ou sigla do dataset.	`3 ou FOREST1`
`date`	Não	Data (AAAA-MM-DD) ou data incompleta (ex. 1888-05-NA) ou array com year/month/day.	`2024-05-20 ou {\"year\":1888,\"month\":5}`
`individual`	Sim	Id, uuid ou organismID do indivíduo.	`4521 ou 2ff0e884-3d33`
`notes`	Não	Notas em texto ou JSON.	`{\"expedition\":\"2024-01\",\"tag\":\"P1\"}`
`number`	Não	Número/código de coletor (voucher ou tag quando diferente).	`1234A`

datasets (POST)

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

Parâmetro	Obrigatório	Descrição	Exemplo
`description`	Não	Descrição em texto ou mapa de traducao. (Required when privacy is 2 or 3.)	`{\"en\":\"Leaf length\",\"pt-br\":\"Comprimento da folha\"}`
`license`	Não	Licenca publica para mídia (CC0, CC-BY, CC-BY-SA, etc.). (Required when privacy is 2 or 3.)	`CC-BY-SA`
`name`	Sim	Short name or nickname for the dataset - make informative, shorter than title.	`Morphometrics-Aniba`
`privacy`	Sim	(Accepted values: 0 (auth), 1 (project), 2 (registered), 3 (public).)	—
`project_id`	Não	(Required when privacy is 1 (project).)	—
`share_taxon_list`	Não	Opção do dataset que controla se a lista de táxons pode ser compartilhada em contextos públicos de filogenia/lista taxonômica. (Optional boolean; defaults to true.)	`1 ou true`
`title`	Não	(Required when privacy is 2 or 3.)	—
`visibility`	Não	(Optional for privacy 0 or 1; mandatory true when privacy is 2 or 3.)	—

identification-histories (POST)

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

Parâmetro	Obrigatório	Descrição	Exemplo
`biocollection_id`	Não	Lista de ids de biocoleção para filtrar vouchers.	`1,5`
`biocollection_reference`	Não	(Requires biocollection_id when provided.)	—
`date`	Sim	Data (AAAA-MM-DD) ou data incompleta (ex. 1888-05-NA) ou array com year/month/day.	`2024-05-20 ou {\"year\":1888,\"month\":5}`
`identification_id`	Não	Id 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. (Optional. When provided, it must belong to individual_id; otherwise it is derived from individual_id.)	`123`
`identifier`	Não	Pessoa(s) responsavel(is) pela identificacao; aceita id, abreviação, nome ou email; use \| ou ;. Obrigatório quando taxon é informado. Use identifier=collector para usar o valor de collector informado no mesmo registro, ou identifier=keep em updates para preservar o identificador existente. (Provide identifier, identifier_id, or identifiers.)	`A.Costa\|B.Lima ou collector ou keep`
`identifier_id`	Não	Id de pessoa ou lista delimitada de ids de pessoas responsáveis pela identificação. (Provide identifier, identifier_id, or identifiers.)	`4 ou 4\|7`
`identifiers`	Não	Referência de pessoa ou lista delimitada de pessoas responsáveis pela identificação. Cada item pode ser id, abreviação, nome completo ou email. (Provide identifier, identifier_id, or identifiers.)	`4\|7 ou A.Costa\|B.Lima`
`individual_id`	Sim	Ids de indivíduos para ocorrências.	`12,55,90`
`modifier`	Não	Código/nome do modificador de identificacao (s.s.=1, s.l.=2, cf.=3, aff.=4, vel aff.=5).	`3`
`notes`	Não	Notas em texto ou JSON.	`{\"expedition\":\"2024-01\",\"tag\":\"P1\"}`
`replaced_at`	Não	Data/hora em que a identificação foi substituída.	`2026-06-11 10:30:00`
`source`	Não	Rótulo de origem para registros gerados ou importados.	`api`
`taxon_id`	Sim		—

4 - Atualizar dados - PUT

Quais EndPoints permitem PUT na API!

Atenção

individuals (PUT)

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

Parâmetro	Obrigatório	Descrição	Exemplo
`id`	Não	ID numérico do registro a ser atualizado (Provide id or individual_id.)	`12`
`collector`	Não	Coletor(es) id, abreviação, nome ou email. Separe múltiplos com \| ou ;, primeiro e o principal.	`Silva, J.B.\|Costa, M.`
`dataset`	Não	Id ou sigla do dataset.	`3 ou FOREST1`
`date`	Não	Data (AAAA-MM-DD) ou data incompleta (ex. 1888-05-NA) ou array com year/month/day.	`2024-05-20 ou {\"year\":1888,\"month\":5}`
`identification_based_on_biocollection`	Não	Nome/id da biocoleção usada como referência de identificacao.	`INPA`
`identification_based_on_biocollection_number`	Não	O catalogNumber do voucher usado como referência.	`8765`
`identification_date`	Não	Data da identificacao (completa ou incompleta).	`2023-06-NA`
`identification_individual`	Não	Id/organismID do indivíduo cuja identificacao sera reaproveitada.	`3245 ou REC-123`
`identification_notes`	Não	Notas da identificacao.	`Conferido em microscopia`
`identifier`	Não	Pessoa(s) responsavel(is) pela identificacao; aceita id, abreviação, nome ou email; use \| ou ;. Obrigatório quando taxon é informado. Use identifier=collector para usar o valor de collector informado no mesmo registro, ou identifier=keep em updates para preservar o identificador existente.	`A.Costa\|B.Lima ou collector ou keep`
`individual_id`	Não	ID numérico do registro a ser atualizado (Provide id or individual_id.)	`12`
`modifier`	Não	Código/nome do modificador de identificacao (s.s.=1, s.l.=2, cf.=3, aff.=4, vel aff.=5).	`3`
`notes`	Não	Notas em texto ou JSON.	`{\"expedition\":\"2024-01\",\"tag\":\"P1\"}`
`tag`	Não	Tag/número/código do indivíduo.	`A-1234`
`taxon`	Não	Id ou nome canônico do taxon (lista aceita).	`Licaria cannela,Licaria armeniaca ou 456,789`

individual-locations (PUT)

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

Parâmetro	Obrigatório	Descrição	Exemplo
`id`	Não	ID numérico do registro a ser atualizado (Provide id or individual_location_id.)	`12`
`altitude`	Não	Altitude em metros.	`75`
`angle`	Não	Azimute em graus a partir do ponto de referência.	`45`
`distance`	Não	Distância ao ponto de referência em metros.	`12.5`
`individual`	Não	Id, uuid ou organismID do indivíduo.	`4521 ou 2ff0e884-3d33`
`individual_location_id`	Não	Id de individual-location para atualizacao. (Provide id or individual_location_id.)	`44`
`latitude`	Não	Latitude em graus decimais (negativo para sul).	`-3.101`
`location`	Não	Id ou nome do local.	`Parcela 25ha ou 55`
`location_date_time`	Não	Data ou data+hora do evento de localização/ocorrência.	`2023-08-14 12:30:00`
`location_notes`	Não	Notas da ocorrência/local.	`Perto do marco 10`
`longitude`	Não	Longitude em graus decimais (negativo para oeste).	`-60.12`
`x`	Não	Coordenada cartesiana do indivívudo na parcela ou transecto, a partir da origem	`10`
`y`	Não	Coordenada cartesiana do indivívudo na parcela ou transecto. Quando transecto, valores positivos (lado direito), valores negativos (lado esquerdo), a partir da origem	`5.1`

locations (PUT)

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

Parâmetro	Obrigatório	Descrição	Exemplo
`id`	Não	ID numérico do registro a ser atualizado (Provide id or location_id.)	`12`
`adm_level`	Não	Código do nível administrativo do local (ex. 100=parcela, 10=país).	`100`
`altitude`	Não	Altitude em metros.	`75`
`datum`	Não	Datum/projecao espacial.	`EPSG:4326-WGS 84`
`geom`	Não	Geometria WKT (POINT, LINESTRING, POLYGON, MULTIPOLYGON).	`POLYGON((-60 -3,-60.1 -3,-60.1 -3.1,-60 -3.1,-60 -3))`
`ismarine`	Não	Flag para aceitar locais marinhos fora de poligonos de país.	`1`
`lat`	Não	Latitude em graus decimais (negativo para sul).	`-3.101`
`location_id`	Não	Id do local a atualizar. (Provide id or location_id.)	`44`
`long`	Não	Longitude em graus decimais (negativo para oeste).	`-60.12`
`name`	Não	Parametro generico de nome (taxon completo, local, export_name de trait, etc.).	`Ocotea guianensis`
`notes`	Não	Notas em texto ou JSON.	`{\"expedition\":\"2024-01\",\"tag\":\"P1\"}`
`parent`	Não	Id ou nome do pai (taxon ou local).	`Lauraceae ou 210`
`startx`	Não	Coordenada X inicial de subparcela em relação ao plot pai.	`5.5`
`starty`	Não	Coordenada Y inicial de subparcela em relação ao plot pai.	`10.0`
`x`	Não	Dimensão X para plots ou comprimento transecto	`100`
`y`	Não	Dimensão Y para plots ou buffer para transectos (PELD)	`40`

measurements (PUT)

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

Parâmetro	Obrigatório	Descrição	Exemplo
`id`	Não	ID numérico do registro a ser atualizado (Provide id or measurement_id.)	`12`
`bibreference`	Não	Id ou bibkey da referência.	`34`
`dataset`	Não	Id ou sigla do dataset.	`3 ou FOREST1`
`date`	Não	Data (AAAA-MM-DD) ou data incompleta (ex. 1888-05-NA) ou array com year/month/day.	`2024-05-20 ou {\"year\":1888,\"month\":5}`
`duplicated`	Não	Número sequencial para permitir medidas duplicadas do mesmo trait/objeto/data.	`2 para o segundo registro, 3 para o terceiro e assim por diante`
`link_id`	Não	Id do objeto ligado quando o trait e do tipo Link.	`id do taxon 55`
`location`	Não	Id ou nome do local.	`Parcela 25ha ou 55`
`measurement_id`	Não	Id de measurement para atualizacao. (Provide id or measurement_id.)	`77`
`notes`	Não	Notas em texto ou JSON.	`{\"expedition\":\"2024-01\",\"tag\":\"P1\"}`
`object_id`	Não	Id do objeto medido (Individual, Location, Taxon, Voucher ou Media).	`4521`
`object_type`	Não	Tipo do objeto medido: Individual, Location, Taxon, Voucher ou Media.	`Individual`
`parent_measurement`	Não	Id de measurement pai.	`3001`
`person`	Não	Id/abreviação/nome/email de pessoa (aceita lista com \| ou ;).	`Silva, J.B.\|Costa, M.`
`trait_id`	Não	Id ou export_name do trait para measurements.	`12 ou DBH`
`value`	Não	Valor(es) da medida; depende do tipo do trait: QUANT_INTEGER (0) = número inteiro; QUANT_REAL (1) = número decimal, ponto como separator; CATEGORICAL or ORDINAL (2/4) = uma única categoria, pode ser o id ou o nome; CATEGORICAL_MULTIPLE (3) = lista de ids ou nomes de categorias separadas por \| ; ou ,; TEXT (5) = um texto livre; COLOR (6) = cor em formato hex #A1B2C3 or #ABC; LINK (7) = enviar o link_id do object (value pode ser vazio neste caso, ou um número); SPECTRAL (8) = valores de absorbânica/reflectância separados por ponto-e-vírgula (;) com mesmo número de valores especificados na definição da variável; GENEBANK (9) = código alfanumérico do accesso do registro no GenBank (ele é validado contra o NCBI).	`QUANT_REAL: 23.4 \| CATEGORICAL: 15 ou Morta \| CATEGORICAL_MULTIPLE: 12;14 ou Simples;Composta \| SPECTRAL: 0.12;0.11;0.10`

media (PUT)

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

Parâmetro	Obrigatório	Descrição	Exemplo
`id`	Não	Id unico ou lista separada por virgula para filtrar/selecionar registros. (Provide id, media_id or media_uuid.)	`1,2,3`
`collector`	Não	Coletor(es) id, abreviação, nome ou email. Separe múltiplos com \| ou ;, primeiro e o principal.	`Silva, J.B.\|Costa, M.`
`dataset`	Não	Id ou sigla do dataset.	`3 ou FOREST1`
`date`	Não	Data (AAAA-MM-DD) ou data incompleta (ex. 1888-05-NA) ou array com year/month/day.	`2024-05-20 ou {\"year\":1888,\"month\":5}`
`latitude`	Não	Latitude em graus decimais (negativo para sul).	`-3.101`
`license`	Não	Licenca publica para mídia (CC0, CC-BY, CC-BY-SA, etc.).	`CC-BY-SA`
`location`	Não	Id ou nome do local.	`Parcela 25ha ou 55`
`longitude`	Não	Longitude em graus decimais (negativo para oeste).	`-60.12`
`media_id`	Não	Id numerico de mídia. (Provide id, media_id or media_uuid.)	`88`
`media_uuid`	Não	UUID da mídia. (Provide id, media_id or media_uuid.)	`a3f0a4ac-6b5b-11ed-b8c0-0242ac120002`
`notes`	Não	Notas em texto ou JSON.	`{\"expedition\":\"2024-01\",\"tag\":\"P1\"}`
`project`	Não	Id ou sigla do projeto.	`PDBFF ou 2`
`tags`	Não	Ids ou nomes de tags para mídia ou filtros (use \| ou ;).	`flower\|leaf`
`title_en`	Não	Titulo da mídia em ingles.	`Leaf detail`
`title_pt`	Não	Titulo da mídia em portugues.	`Detalhe da folha`

persons (PUT)

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

Parâmetro	Obrigatório	Descrição	Exemplo
`id`	Não	ID numérico do registro a ser atualizado (Provide id or person_id.)	`12`
`abbreviation`	Não	Abreviação padrão de pessoa ou coleção.	`Silva, J.B.`
`biocollection`	Não	Id, nome ou sigla da biocoleção.	`INPA`
`email`	Não	Endereco de email.	`user@example.org`
`full_name`	Não	Nome completo da pessoa.	`Joao Silva`
`institution`	Não	Instituicao associada a pessoa.	`INPA`
`person_id`	Não	Id da pessoa a atualizar. (Provide id or person_id.)	`12`

vouchers (PUT)

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

Parâmetro	Obrigatório	Descrição	Exemplo
`id`	Não	ID numérico do registro a ser atualizado (Provide id or voucher_id.)	`12`
`biocollection`	Não	Id, nome ou sigla da biocoleção.	`INPA`
`biocollection_number`	Não	Número/código do voucher na biocoleção.	`12345`
`biocollection_type`	Não	Código ou nome do tipo nomenclatural.	`Holotype ou 2`
`clear_biocollection_number`	Não	Quando 1, limpa o biocollection_number atual na atualização.	`1`
`collector`	Não	Coletor(es) id, abreviação, nome ou email. Separe múltiplos com \| ou ;, primeiro e o principal.	`Silva, J.B.\|Costa, M.`
`dataset`	Não	Id ou sigla do dataset.	`3 ou FOREST1`
`date`	Não	Data (AAAA-MM-DD) ou data incompleta (ex. 1888-05-NA) ou array com year/month/day.	`2024-05-20 ou {\"year\":1888,\"month\":5}`
`individual`	Não	Id, uuid ou organismID do indivíduo.	`4521 ou 2ff0e884-3d33`
`notes`	Não	Notas em texto ou JSON.	`{\"expedition\":\"2024-01\",\"tag\":\"P1\"}`
`number`	Não	Número/código de coletor (voucher ou tag quando diferente).	`1234A`
`voucher_id`	Não	Id do voucher a atualizar. (Provide id or voucher_id.)	`55`

taxons (PUT)

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

Parâmetro	Obrigatório	Descrição	Exemplo
`id`	Não	Id existente do táxon a ser atualizado. taxon_id também é aceito como alias. (Provide id or taxon_id.)	`12`
`author`	Não	Autoria do nome taxonômico para nomes publicados. Para nomes não publicados, deixe este campo nulo e use author_id/person.	`Smith & Jones`
`author_id`	Não	Id opcional do autor de nome não publicado. Quando presente, o táxon é tratado como não publicado para a verificação de duplicidade.	`25`
`bibkey`	Não	Id de referência bibliográfica ou bibkey, opcional, para resolver bibreference_id.	`ducke1953 ou 34`
`bibreference`	Não	Id ou bibkey da referência.	`34`
`bibreference_id`	Não	Lista de ids de BibReference para filtrar vouchers.	`10,11`
`enforceValid`	Não	Override booleano opcional para atualização de nomes publicados. Use quando você quiser manter valid=true mesmo que a API informe que o nome é inválido e retorne um nome sênior.	`1 ou true`
`gbif`	Não	Id explícito opcional do GBIF. Se a mudança de nome de um táxon publicado acionar consulta à API, o valor retornado pela API tem prioridade; caso contrário, o valor informado é salvo sem validação extra.	`28792`
`indexfungorum`	Não	Identificador Index Fungorum de um táxon.	`IF123456`
`ipni`	Não	Id explícito opcional do IPNI. Se a mudança de nome de um táxon publicado acionar consulta à API, o valor retornado pela API tem prioridade; caso contrário, o valor informado é salvo sem validação extra.	`123456-1`
`level`	Não	Novo código/nome de rank, opcional. Necessário quando a alteração em um táxon não publicado exige revalidar o rank e sempre checado contra o parent.	`210 ou species`
`mobot`	Não	Id explícito opcional do Tropicos/MOBOT. Se a mudança de nome de um táxon publicado acionar consulta à API, o valor retornado pela API tem prioridade; caso contrário, o valor informado é salvo sem validação extra.	`25509881`
`mycobank`	Não	Id explícito opcional do MycoBank. Se a mudança de nome de um táxon publicado acionar consulta à API, o valor retornado pela API tem prioridade; caso contrário, o valor informado é salvo sem validação extra.	`MB123456`
`name`	Não	Novo nome do táxon, opcional. Se o táxon for publicado e o nome mudar, as APIs externas são consultadas novamente e podem sobrescrever parent, rank, valid, senior_id, author, bibreference e ids externos informados. Se o táxon for não publicado e o nome mudar, aplica-se verificação de duplicidade em vez de consulta à API.	`Ocotea guianensis`
`notes`	Não	Substituição opcional de notes. Aceita texto simples ou string JSON.	`{"reviewed_by":"J. Silva"}`
`parent`	Não	Novo pai opcional, aceitando id ou nome científico. Toda mudança de nome e toda mudança de parent passam novamente pela validação de nível taxonômico.	`Ocotea ou 120`
`parent_id`	Não	Id do pai para consultas hierarquicas.	`210`
`parent_name`	Não	Nome alternativo do táxon pai usado em importações e atualizações de táxons.	`Ocotea`
`person`	Não	Referência opcional do autor para táxons não publicados. Aceita id, abreviação, nome completo ou email e resolve para author_id.	`25 ou Pilco, M.V.`
`senior_id`	Não	Id opcional do nome aceito. Só é permitido quando valid=false. O táxon sênior referenciado deve ser válido e publicado; nomes sênior não publicados são rejeitados.	`345`
`taxon_id`	Não	Alias de id para payloads de atualização. (Provide id or taxon_id.)	`12`
`valid`	Não	Booleano opcional. Táxons publicados e não publicados podem ser inválidos. Se valid=true, senior_id é limpo. Se valid=false em um nome publicado, senior_id deve ser informado. Se você enviar valid=true para a mudança de nome de um táxon publicado e a API disser que o nome é inválido, a atualização é rejeitada, a menos que enforceValid=true também seja enviado.	`1 ou 0`
`zoobank`	Não	Id explícito opcional do ZooBank. Se a mudança de nome de um táxon publicado acionar consulta à API, o valor retornado pela API tem prioridade; caso contrário, o valor informado é salvo sem validação extra.	`urn:lsid:zoobank.org:act:XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX`

Serviços de API

A interação com a API do OpenDataBio

Autenticação da API

Versões da API

1 - Referência rápida

OBTER DADOS - GET

Parâmetros GET compartilhados

Parâmetros GET específicos

Importar ou Validar dados - POST

Atualizar dados - PUT

Nomenclature Types

Níveis taxonômicos (Ranks)

2 - Obter dados - GET

Parâmetros GET compartilhados

Selecionar campos da resposta

Endpoints GET

Links rápidos

/ (GET)

bibreferences (GET)

Campos retornados

Exemplo de resposta

biocollections (GET)

Campos retornados

Exemplo de resposta

datasets (GET)

Campos retornados

Exemplo de resposta

individuals (GET)

Campos retornados

Exemplo de resposta

individual-locations (GET)

Campos retornados

Exemplo de resposta

languages (GET)

Exemplo de resposta

locations (GET)

Campos retornados

Exemplo de resposta

measurements (GET)

Campos retornados

Exemplo de resposta

media (GET)

Campos retornados

Exemplo de resposta

persons (GET)

Campos retornados

Exemplo de resposta

projects (GET)

Campos retornados

Exemplo de resposta

taxons (GET)

Campos retornados

Exemplo de resposta

traits (GET)

Campos retornados

Exemplo de resposta

vernaculars (GET)

Campos retornados

Exemplo de resposta

vouchers (GET)

Campos retornados

Exemplo de resposta

userjobs (GET)

Campos retornados

Exemplo de resposta

activities (GET)

Campos retornados

Exemplo de resposta

tags (GET)

Campos retornados

Exemplo de resposta

brahms (GET)

Campos retornados

identification-histories (GET)

Campos retornados

3 - Inserir dados - POST

Importando dados

Dados estruturados personalizados no campo notes

Endpoints POST

Links rápidos

Dados estruturados personalizados no campo `notes`