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](/docs/api/get-data/#userjobs-endpoint).

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 arquivos de versões publicadas (GET lista, POST cria via job de importação).	id, bibreference, fields, file_name, has_versions, include_url, limit, list_versions, name, offset, project, save_job, search, summarize, tag, tagged_with, taxon, taxon_root, traits
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

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, bibreference, gbif, ipni, level, mobot, mycobank, name, parent, person, 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 arquivos de versões publicadas (GET lista, POST cria via job de importação).	description, license, name, privacy, project_id, title

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, collector, dataset, date, individual, notes, number, voucher_id

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 ](https://gitlab.com/opendatabio/opendatabio-r) é um **cliente** para esta API, [exemplos de uso aqui](/docs/tutorials/01-get-r-vignette); - 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?

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.

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

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

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

Exemplo de resposta

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

biocollections (GET)

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

Parâ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

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

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

Exemplo de resposta

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

datasets (GET)

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

Parâ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`
`file_name`	Não	Nome do arquivo de versão de dataset para download.	`2_Organisms.csv`
`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 para download do arquivo.	`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`

Campos retornados

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

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

Exemplo de resposta

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

individuals (GET)

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

Parâ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

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

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

Exemplo de resposta

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

individual-locations (GET)

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

Parâ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

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

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

Exemplo de resposta

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

languages (GET)

Lista idiomas disponíveis.

Parâ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

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

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

Exemplo de resposta

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

measurements (GET)

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

Parâ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

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

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

Exemplo de resposta

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

media (GET)

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

Parâ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

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

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

Exemplo de resposta

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

persons (GET)

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

Parâ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

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

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

Exemplo de resposta

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

projects (GET)

Projetos (GET lista).

Parâ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

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

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

Exemplo de resposta

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

taxons (GET)

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

Parâ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

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

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

Exemplo de resposta

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

traits (GET)

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

Parâ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	`en ou 1 ou english ou portugues ou pt-br`
`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

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

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

Exemplo de resposta

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

vernaculars (GET)

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

Parâ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

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

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

Exemplo de resposta

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

vouchers (GET)

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

Parâ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

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

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

Exemplo de resposta

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

userjobs (GET)

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

Parâ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

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

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

Exemplo de resposta

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

activities (GET)

Lista entradas do log de atividades.

Parâ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	`en ou 1 ou english ou portugues ou pt-br`
`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

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

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

Exemplo de resposta

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

tags (GET)

Tags/palavras-chave (GET lista).

Parâ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	`en ou 1 ou english ou portugues ou pt-br`
`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

Campos (simple): id, name, description

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

Exemplo de resposta

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

3 - Inserir dados - POST

Como importar dados ao OpenDataBio usando a API

Importando dados

- O [pacote OpenDataBio ](https://gitlab.com/opendatabio/opendatabio-r) é um **cliente** para esta API e permite importar dados a partir de objetos da linguagem R ([exemplos](/docs/tutorials/02-post-data-r-vignette)); - 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

Dados estruturados perzonalizados 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 ;.	`A.Costa\|B.Lima`
`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 X para plots ou posicao de indivíduo.	`12.3`
`y`	Não	Coordenada Y para plots ou posicao de indivíduo.	`8.7`

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 X para plots ou posicao de indivíduo.	`12.3`
`y`	Não	Coordenada Y para plots ou posicao de indivíduo.	`8.7`

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 unica com geometria e pelo menos name + adm_level nas properties.	`{\"type\":\"Feature\",\"properties\":{\"name\":\"Plot A\",\"adm_level\":100},\"geometry\":{...}}`
`geom`	Não	Geometria WKT (POINT, LINESTRING, POLYGON, MULTIPOLYGON). (Provide 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 geom or lat+long.)	`-3.101`
`long`	Não	Longitude em graus decimais (negativo para oeste). (Provide 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	Coordenada X para plots ou posicao de indivíduo.	`12.3`
`y`	Não	Coordenada Y para plots ou posicao de indivíduo.	`8.7`

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, Voucher ou Media.	`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	Autor do nome taxonômico (para nomes não publicados).	`Smith & Jones`
`author_id`	Não	Id/nome/email da pessoa autora de nome não publicado. (Required for unpublished names (or use person).)	`25`
`bibreference`	Não	Id ou bibkey da referência.	`34`
`gbif`	Não	nubKey do GBIF para taxon.	`28792`
`ipni`	Não	Id IPNI para taxon.	`123456-1`
`level`	Não	Código ou string do nível taxonômico.	`210 ou species`
`mobot`	Não	Id do Tropicos para taxon.	`12345678`
`mycobank`	Não	Id MycoBank para taxon.	`MB123456`
`name`	Sim	Parametro generico de nome (taxon completo, local, export_name de trait, etc.).	`Ocotea guianensis`
`parent`	Não	Id ou nome do pai (taxon ou local). (Required for unpublished names.)	`Lauraceae ou 210`
`person`	Não	Id/abreviação/nome/email de pessoa (aceita lista com \| ou ;). (Required for unpublished names (or use author_id).)	`Silva, J.B.\|Costa, M.`
`valid`	Não	Quando 1 retorna apenas nomes taxonômicos validos.	`1`
`zoobank`	Não	Id ZooBank para taxon.	`urn:lsid:zoobank.org:act:12345678`

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 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	`en ou 1 ou english ou portugues ou pt-br`
`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 arquivos de versões publicadas (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).)	—
`title`	Não	(Required when privacy is 2 or 3.)	—

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 ;.	`A.Costa\|B.Lima`
`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 X para plots ou posicao de indivíduo.	`12.3`
`y`	Não	Coordenada Y para plots ou posicao de indivíduo.	`8.7`

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	Coordenada X para plots ou posicao de indivíduo.	`12.3`
`y`	Não	Coordenada Y para plots ou posicao de indivíduo.	`8.7`

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`
`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`

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

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

3 - Inserir dados - POST

Importando dados

Dados estruturados perzonalizados no campo notes

Endpoints POST

Links rápidos

bibreferences (POST)

biocollections (POST)

individuals (POST)

individual-locations (POST)

locations (POST)

Dados estruturados perzonalizados no campo `notes`