Atualizar dados - PUT
Quais EndPoints permitem PUT na API!
10 minute read
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.
Links rápidos
individuals (PUT)
Indivíduos (GET lista, POST cria, PUT atualiza).
| Parâmetro | Obrigatório | Descrição | Exemplo |
|---|---|---|---|
id | Não | ID numérico do registro a ser atualizado (Provide id or individual_id.) | 12 |
collector | Não | Coletor(es) id, abreviação, nome ou email. Separe múltiplos com | ou ;, primeiro e o principal. | Silva, J.B.|Costa, M. |
dataset | Não | Id ou sigla do dataset. | 3 ou FOREST1 |
date | Não | Data (AAAA-MM-DD) ou data incompleta (ex. 1888-05-NA) ou array com year/month/day. | 2024-05-20 ou {\"year\":1888,\"month\":5} |
identification_based_on_biocollection | Não | Nome/id da biocoleção usada como referência de identificacao. | INPA |
identification_based_on_biocollection_number | Não | O catalogNumber do voucher usado como referência. | 8765 |
identification_date | Não | Data da identificacao (completa ou incompleta). | 2023-06-NA |
identification_individual | Não | Id/organismID do indivíduo cuja identificacao sera reaproveitada. | 3245 ou REC-123 |
identification_notes | Não | Notas da identificacao. | Conferido em microscopia |
identifier | Não | Pessoa(s) responsavel(is) pela identificacao; aceita id, abreviação, nome ou email; use | ou ;. Obrigatório quando taxon é informado. Use identifier=collector para usar o valor de collector informado no mesmo registro, ou identifier=keep em updates para preservar o identificador existente. | A.Costa|B.Lima ou collector ou keep |
individual_id | Não | ID numérico do registro a ser atualizado (Provide id or individual_id.) | 12 |
modifier | Não | Código/nome do modificador de identificacao (s.s.=1, s.l.=2, cf.=3, aff.=4, vel aff.=5). | 3 |
notes | Não | Notas em texto ou JSON. | {\"expedition\":\"2024-01\",\"tag\":\"P1\"} |
tag | Não | Tag/número/código do indivíduo. | A-1234 |
taxon | Não | Id ou nome canônico do taxon (lista aceita). | Licaria cannela,Licaria armeniaca ou 456,789 |
individual-locations (PUT)
Ocorrências para indivíduos com múltiplas localizações (GET lista, POST/PUT grava).
| Parâmetro | Obrigatório | Descrição | Exemplo |
|---|---|---|---|
id | Não | ID numérico do registro a ser atualizado (Provide id or individual_location_id.) | 12 |
altitude | Não | Altitude em metros. | 75 |
angle | Não | Azimute em graus a partir do ponto de referência. | 45 |
distance | Não | Distância ao ponto de referência em metros. | 12.5 |
individual | Não | Id, uuid ou organismID do indivíduo. | 4521 ou 2ff0e884-3d33 |
individual_location_id | Não | Id de individual-location para atualizacao. (Provide id or individual_location_id.) | 44 |
latitude | Não | Latitude em graus decimais (negativo para sul). | -3.101 |
location | Não | Id ou nome do local. | Parcela 25ha ou 55 |
location_date_time | Não | Data ou data+hora do evento de localização/ocorrência. | 2023-08-14 12:30:00 |
location_notes | Não | Notas da ocorrência/local. | Perto do marco 10 |
longitude | Não | Longitude em graus decimais (negativo para oeste). | -60.12 |
x | Não | Coordenada cartesiana do indivívudo na parcela ou transecto, a partir da origem | 10 |
y | Não | Coordenada cartesiana do indivívudo na parcela ou transecto. Quando transecto, valores positivos (lado direito), valores negativos (lado esquerdo), a partir da origem | 5.1 |
locations (PUT)
Localidades (GET lista, POST cria, PUT atualiza).
| Parâmetro | Obrigatório | Descrição | Exemplo |
|---|---|---|---|
id | Não | ID numérico do registro a ser atualizado (Provide id or location_id.) | 12 |
adm_level | Não | Código do nível administrativo do local (ex. 100=parcela, 10=país). | 100 |
altitude | Não | Altitude em metros. | 75 |
datum | Não | Datum/projecao espacial. | EPSG:4326-WGS 84 |
geom | Não | Geometria WKT (POINT, LINESTRING, POLYGON, MULTIPOLYGON). | POLYGON((-60 -3,-60.1 -3,-60.1 -3.1,-60 -3.1,-60 -3)) |
ismarine | Não | Flag para aceitar locais marinhos fora de poligonos de país. | 1 |
lat | Não | Latitude em graus decimais (negativo para sul). | -3.101 |
location_id | Não | Id do local a atualizar. (Provide id or location_id.) | 44 |
long | Não | Longitude em graus decimais (negativo para oeste). | -60.12 |
name | Não | Parametro generico de nome (taxon completo, local, export_name de trait, etc.). | Ocotea guianensis |
notes | Não | Notas em texto ou JSON. | {\"expedition\":\"2024-01\",\"tag\":\"P1\"} |
parent | Não | Id ou nome do pai (taxon ou local). | Lauraceae ou 210 |
startx | Não | Coordenada X inicial de subparcela em relação ao plot pai. | 5.5 |
starty | Não | Coordenada Y inicial de subparcela em relação ao plot pai. | 10.0 |
x | Não | Dimensão X para plots ou comprimento transecto | 100 |
y | Não | Dimensão Y para plots ou buffer para transectos (PELD) | 40 |
measurements (PUT)
Medições de traits (GET lista, POST cria via job de importação, PUT atualiza).
| Parâmetro | Obrigatório | Descrição | Exemplo |
|---|---|---|---|
id | Não | ID numérico do registro a ser atualizado (Provide id or measurement_id.) | 12 |
bibreference | Não | Id ou bibkey da referência. | 34 |
dataset | Não | Id ou sigla do dataset. | 3 ou FOREST1 |
date | Não | Data (AAAA-MM-DD) ou data incompleta (ex. 1888-05-NA) ou array com year/month/day. | 2024-05-20 ou {\"year\":1888,\"month\":5} |
duplicated | Não | Número sequencial para permitir medidas duplicadas do mesmo trait/objeto/data. | 2 para o segundo registro, 3 para o terceiro e assim por diante |
link_id | Não | Id do objeto ligado quando o trait e do tipo Link. | id do taxon 55 |
location | Não | Id ou nome do local. | Parcela 25ha ou 55 |
measurement_id | Não | Id de measurement para atualizacao. (Provide id or measurement_id.) | 77 |
notes | Não | Notas em texto ou JSON. | {\"expedition\":\"2024-01\",\"tag\":\"P1\"} |
object_id | Não | Id do objeto medido (Individual, Location, Taxon, Voucher ou Media). | 4521 |
object_type | Não | Tipo do objeto medido: Individual, Location, Taxon, Voucher ou Media. | Individual |
parent_measurement | Não | Id de measurement pai. | 3001 |
person | Não | Id/abreviação/nome/email de pessoa (aceita lista com | ou ;). | Silva, J.B.|Costa, M. |
trait_id | Não | Id ou export_name do trait para measurements. | 12 ou DBH |
value | Não | Valor(es) da medida; depende do tipo do trait: QUANT_INTEGER (0) = número inteiro; QUANT_REAL (1) = número decimal, ponto como separator; CATEGORICAL or ORDINAL (2/4) = uma única categoria, pode ser o id ou o nome; CATEGORICAL_MULTIPLE (3) = lista de ids ou nomes de categorias separadas por | ; ou ,; TEXT (5) = um texto livre; COLOR (6) = cor em formato hex #A1B2C3 or #ABC; LINK (7) = enviar o link_id do object (value pode ser vazio neste caso, ou um número); SPECTRAL (8) = valores de absorbânica/reflectância separados por ponto-e-vírgula (;) com mesmo número de valores especificados na definição da variável; GENEBANK (9) = código alfanumérico do accesso do registro no GenBank (ele é validado contra o NCBI). | QUANT_REAL: 23.4 | CATEGORICAL: 15 ou Morta | CATEGORICAL_MULTIPLE: 12;14 ou Simples;Composta | SPECTRAL: 0.12;0.11;0.10 |
media (PUT)
Metadados de mídia (GET lista, POST cria, PUT atualiza).
| Parâmetro | Obrigatório | Descrição | Exemplo |
|---|---|---|---|
id | Não | Id unico ou lista separada por virgula para filtrar/selecionar registros. (Provide id, media_id or media_uuid.) | 1,2,3 |
collector | Não | Coletor(es) id, abreviação, nome ou email. Separe múltiplos com | ou ;, primeiro e o principal. | Silva, J.B.|Costa, M. |
dataset | Não | Id ou sigla do dataset. | 3 ou FOREST1 |
date | Não | Data (AAAA-MM-DD) ou data incompleta (ex. 1888-05-NA) ou array com year/month/day. | 2024-05-20 ou {\"year\":1888,\"month\":5} |
latitude | Não | Latitude em graus decimais (negativo para sul). | -3.101 |
license | Não | Licenca publica para mídia (CC0, CC-BY, CC-BY-SA, etc.). | CC-BY-SA |
location | Não | Id ou nome do local. | Parcela 25ha ou 55 |
longitude | Não | Longitude em graus decimais (negativo para oeste). | -60.12 |
media_id | Não | Id numerico de mídia. (Provide id, media_id or media_uuid.) | 88 |
media_uuid | Não | UUID da mídia. (Provide id, media_id or media_uuid.) | a3f0a4ac-6b5b-11ed-b8c0-0242ac120002 |
notes | Não | Notas em texto ou JSON. | {\"expedition\":\"2024-01\",\"tag\":\"P1\"} |
project | Não | Id ou sigla do projeto. | PDBFF ou 2 |
tags | Não | Ids ou nomes de tags para mídia ou filtros (use | ou ;). | flower|leaf |
title_en | Não | Titulo da mídia em ingles. | Leaf detail |
title_pt | Não | Titulo da mídia em portugues. | Detalhe da folha |
persons (PUT)
Pessoas (GET lista, POST cria, PUT atualiza).
| Parâmetro | Obrigatório | Descrição | Exemplo |
|---|---|---|---|
id | Não | ID numérico do registro a ser atualizado (Provide id or person_id.) | 12 |
abbreviation | Não | Abreviação padrão de pessoa ou coleção. | Silva, J.B. |
biocollection | Não | Id, nome ou sigla da biocoleção. | INPA |
email | Não | Endereco de email. | user@example.org |
full_name | Não | Nome completo da pessoa. | Joao Silva |
institution | Não | Instituicao associada a pessoa. | INPA |
person_id | Não | Id da pessoa a atualizar. (Provide id or person_id.) | 12 |
vouchers (PUT)
Vouchers de coleção (GET lista, POST cria, PUT atualiza).
| Parâmetro | Obrigatório | Descrição | Exemplo |
|---|---|---|---|
id | Não | ID numérico do registro a ser atualizado (Provide id or voucher_id.) | 12 |
biocollection | Não | Id, nome ou sigla da biocoleção. | INPA |
biocollection_number | Não | Número/código do voucher na biocoleção. | 12345 |
biocollection_type | Não | Código ou nome do tipo nomenclatural. | Holotype ou 2 |
clear_biocollection_number | Não | Quando 1, limpa o biocollection_number atual na atualização. | 1 |
collector | Não | Coletor(es) id, abreviação, nome ou email. Separe múltiplos com | ou ;, primeiro e o principal. | Silva, J.B.|Costa, M. |
dataset | Não | Id ou sigla do dataset. | 3 ou FOREST1 |
date | Não | Data (AAAA-MM-DD) ou data incompleta (ex. 1888-05-NA) ou array com year/month/day. | 2024-05-20 ou {\"year\":1888,\"month\":5} |
individual | Não | Id, uuid ou organismID do indivíduo. | 4521 ou 2ff0e884-3d33 |
notes | Não | Notas em texto ou JSON. | {\"expedition\":\"2024-01\",\"tag\":\"P1\"} |
number | Não | Número/código de coletor (voucher ou tag quando diferente). | 1234A |
voucher_id | Não | Id do voucher a atualizar. (Provide id or voucher_id.) | 55 |
taxons (PUT)
Nomes taxonômicos (GET lista, POST cria).
| Parâmetro | Obrigatório | Descrição | Exemplo |
|---|---|---|---|
id | Não | Id existente do táxon a ser atualizado. taxon_id também é aceito como alias. (Provide id or taxon_id.) | 12 |
author | Não | Autoria do nome taxonômico para nomes publicados. Para nomes não publicados, deixe este campo nulo e use author_id/person. | Smith & Jones |
author_id | Não | Id opcional do autor de nome não publicado. Quando presente, o táxon é tratado como não publicado para a verificação de duplicidade. | 25 |
bibkey | Não | Id de referência bibliográfica ou bibkey, opcional, para resolver bibreference_id. | ducke1953 ou 34 |
bibreference | Não | Id ou bibkey da referência. | 34 |
bibreference_id | Não | Lista de ids de BibReference para filtrar vouchers. | 10,11 |
enforceValid | Não | Override booleano opcional para atualização de nomes publicados. Use quando você quiser manter valid=true mesmo que a API informe que o nome é inválido e retorne um nome sênior. | 1 ou true |
gbif | Não | Id explícito opcional do GBIF. Se a mudança de nome de um táxon publicado acionar consulta à API, o valor retornado pela API tem prioridade; caso contrário, o valor informado é salvo sem validação extra. | 28792 |
indexfungorum | Não | Identificador Index Fungorum de um táxon. | IF123456 |
ipni | Não | Id explícito opcional do IPNI. Se a mudança de nome de um táxon publicado acionar consulta à API, o valor retornado pela API tem prioridade; caso contrário, o valor informado é salvo sem validação extra. | 123456-1 |
level | Não | Novo código/nome de rank, opcional. Necessário quando a alteração em um táxon não publicado exige revalidar o rank e sempre checado contra o parent. | 210 ou species |
mobot | Não | Id explícito opcional do Tropicos/MOBOT. Se a mudança de nome de um táxon publicado acionar consulta à API, o valor retornado pela API tem prioridade; caso contrário, o valor informado é salvo sem validação extra. | 25509881 |
mycobank | Não | Id explícito opcional do MycoBank. Se a mudança de nome de um táxon publicado acionar consulta à API, o valor retornado pela API tem prioridade; caso contrário, o valor informado é salvo sem validação extra. | MB123456 |
name | Não | Novo nome do táxon, opcional. Se o táxon for publicado e o nome mudar, as APIs externas são consultadas novamente e podem sobrescrever parent, rank, valid, senior_id, author, bibreference e ids externos informados. Se o táxon for não publicado e o nome mudar, aplica-se verificação de duplicidade em vez de consulta à API. | Ocotea guianensis |
notes | Não | Substituição opcional de notes. Aceita texto simples ou string JSON. | {"reviewed_by":"J. Silva"} |
parent | Não | Novo pai opcional, aceitando id ou nome científico. Toda mudança de nome e toda mudança de parent passam novamente pela validação de nível taxonômico. | Ocotea ou 120 |
parent_id | Não | Id do pai para consultas hierarquicas. | 210 |
parent_name | Não | Nome alternativo do táxon pai usado em importações e atualizações de táxons. | Ocotea |
person | Não | Referência opcional do autor para táxons não publicados. Aceita id, abreviação, nome completo ou email e resolve para author_id. | 25 ou Pilco, M.V. |
senior_id | Não | Id opcional do nome aceito. Só é permitido quando valid=false. O táxon sênior referenciado deve ser válido e publicado; nomes sênior não publicados são rejeitados. | 345 |
taxon_id | Não | Alias de id para payloads de atualização. (Provide id or taxon_id.) | 12 |
valid | Não | Booleano opcional. Táxons publicados e não publicados podem ser inválidos. Se valid=true, senior_id é limpo. Se valid=false em um nome publicado, senior_id deve ser informado. Se você enviar valid=true para a mudança de nome de um táxon publicado e a API disser que o nome é inválido, a atualização é rejeitada, a menos que enforceValid=true também seja enviado. | 1 ou 0 |
zoobank | Não | Id explícito opcional do ZooBank. Se a mudança de nome de um táxon publicado acionar consulta à API, o valor retornado pela API tem prioridade; caso contrário, o valor informado é salvo sem validação extra. | urn:lsid:zoobank.org:act:XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX |