Referência rápida

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

  7 minute read  

OBTER DADOS - GET

Parâmetros GET compartilhados

ParâmetroObrigatórioDescriçãoExemplo
idNãoId unico ou lista separada por virgula para filtrar/selecionar registros.1,2,3
limitNãoQuantidade maxima de registros retornados.100
offsetNãoA posição inicial do conjunto de registros a ser exportado. Usado em conjunto com limit para limitar os resultados.10000
fieldsNãoLista separada por vírgulas dos campos a serem incluídos na resposta ou uma palavra especial all/simple/raw, padrão: simpleid,scientificName ou all
save_jobNãoSe 1, salva a consulta como job para baixar depois via userjobs + get_file = 11

Parâmetros GET específicos

EndpointDescriçãoParâmetros
/Testa seu acesso/token.—
bibreferencesReferências bibliográficas (GET lista, POST cria).id, bibkey, biocollection, dataset, fields, job_id, limit, offset, save_job, search, taxon, taxon_root
biocollectionsBiocoleções (GET lista, POST cria).id, acronym, fields, irn, job_id, limit, name, offset, save_job, search
datasetsDatasets 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
individualsIndiví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-locationsOcorrê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
languagesLista idiomas disponíveis.fields, limit, offset
locationsLocalidades (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
measurementsMediçõ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
mediaMetadados 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
personsPessoas (GET lista, POST cria, PUT atualiza).id, abbrev, email, fields, job_id, limit, name, offset, save_job, search
projectsProjetos (GET lista).id, fields, job_id, limit, offset, save_job, search, tag
taxonsNomes 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
traitsDefiniçõ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
vernacularsNomes vernáculos (GET lista, POST cria).id, fields, individual, job_id, limit, location, location_root, offset, save_job, taxon, taxon_root
vouchersVouchers 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
userjobsJobs em background (importações/exportações) (GET lista).id, fields, get_file, limit, offset, status
activitiesLista 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
tagsTags/palavras-chave (GET lista).id, dataset, fields, job_id, language, limit, name, offset, project, save_job, search, trait

Importar ou Validar dados - POST

EndpointDescriçãoParâmetros
bibreferencesReferências bibliográficas (GET lista, POST cria).bibtex, doi
biocollectionsBiocoleções (GET lista, POST cria).acronym, name
individualsIndiví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-locationsOcorrê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
locationsLocalidades (GET lista, POST cria, PUT atualiza).adm_level, altitude, azimuth, datum, geojson, geom, ismarine, lat, long, name, notes, parent, startx, starty, x, y
locations-validationValida coordenadas com locais registrados (POST).latitude, longitude
measurementsMediçõ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
mediaMetadados 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
personsPessoas (GET lista, POST cria, PUT atualiza).abbreviation, biocollection, email, full_name, institution
taxonsNomes taxonômicos (GET lista, POST cria).author, author_id, bibreference, gbif, ipni, level, mobot, mycobank, name, parent, person, valid, zoobank
traitsDefiniçõ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
vernacularsNomes vernáculos (GET lista, POST cria).citations, individuals, language, name, notes, parent, taxons, type
vouchersVouchers de coleção (GET lista, POST cria, PUT atualiza).biocollection, biocollection_number, biocollection_type, collector, dataset, date, individual, notes, number
datasetsDatasets 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

EndpointDescriçãoParâmetros
individualsIndiví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-locationsOcorrê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
locationsLocalidades (GET lista, POST cria, PUT atualiza).id, adm_level, altitude, datum, geom, ismarine, lat, location_id, long, name, notes, parent, startx, starty, x, y
measurementsMediçõ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
mediaMetadados 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
personsPessoas (GET lista, POST cria, PUT atualiza).id, abbreviation, biocollection, email, full_name, institution, person_id
vouchersVouchers 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 : 0Isosyntype : 8
Type : 1Neotype : 9
Holotype : 2Epitype : 10
Isotype : 3Isoepitype : 11
Paratype : 4Cultivartype : 12
Lectotype : 5Clonotype : 13
Isolectotype : 6Topotype : 14
Syntype : 7Phototype : 15

Níveis taxonômicos (Ranks)

CódigoNível
-100clade
0kingdom
10subkingd.
30div., phyl., phylum, division
40subdiv.
60cl., class
70subcl., subclass
80superord., superorder
90ord., order
100subord.
120fam., family
130subfam., subfamily
150tr., tribe
180gen., genus
190subg., subgenus, sect.
210section, sp., spec., species
220subsp., subspecies
240var., variety
270f., fo., form
Última modificação December 16, 2025: Improved sync between odb schema and docs (c5bc51e)