Inserir dados - POST

Como importar dados ao OpenDataBio usando a API

11 minute read

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.)	—

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