Skip to content

OniClient data models

Generated from vars_client.generated.oni.models -- every field name and type here is exactly what the client returns/accepts. Do not hand-edit this file.

AuthorizationSC

vars_client.generated.oni.models.authorization_s_c.AuthorizationSC

Field Type
access_token Optional[str]
token_type Optional[str]

BadRequest

vars_client.generated.oni.models.bad_request.BadRequest

Field Type
message Optional[str]
response_code Optional[int]

ConceptCreate

vars_client.generated.oni.models.concept_create.ConceptCreate

Field Type
aphia_id Optional[int]
author Optional[str]
name Optional[str]
parent_name Optional[str]
rank_level Optional[str]
rank_name Optional[str]

ConceptMetadata

vars_client.generated.oni.models.concept_metadata.ConceptMetadata

Field Type
alternate_names Optional[list[str]]
aphia_id Optional[int]
author Optional[str]
id Optional[int]
link_realizations Optional[list[Link]]
media Optional[list[Media]]
name Optional[str]
rank Optional[str]
rank_level Optional[str]
rank_name Optional[str]
references Optional[list[Reference]]

ConceptNameCreate

vars_client.generated.oni.models.concept_name_create.ConceptNameCreate

Field Type
author Optional[str]
name Optional[str]
name_type Optional[str]
new_name Optional[str]

ConceptNameUpdate

vars_client.generated.oni.models.concept_name_update.ConceptNameUpdate

Field Type
author Optional[str]
name_type Optional[str]
new_name Optional[str]

ConceptUpdate

vars_client.generated.oni.models.concept_update.ConceptUpdate

Field Type
aphia_id Optional[int]
parent_name Optional[str]
rank_level Optional[str]
rank_name Optional[str]

Count

vars_client.generated.oni.models.count.Count

Field Type
count Optional[int]

ExtendedHistory

vars_client.generated.oni.models.extended_history.ExtendedHistory

Field Type
action Optional[str]
approved Optional[bool]
concept Optional[str]
creation_timestamp Optional[str]
creator_name Optional[str]
field Optional[str]
id Optional[int]
new_value Optional[str]
old_value Optional[str]
processed_timestamp Optional[str]
processor_name Optional[str]

vars_client.generated.oni.models.extended_link.ExtendedLink

Field Type
concept Optional[str]
id Optional[int]
last_updated Optional[str]
link_name Optional[str]
link_value Optional[str]
to_concept Optional[str]

HealthStatus

vars_client.generated.oni.models.health_status.HealthStatus

Field Type
application Optional[str]
available_processors Optional[int]
description Optional[str]
free_memory Optional[int]
jdk_version Optional[str]
max_memory Optional[int]
total_memory Optional[int]
version Optional[str]

vars_client.generated.oni.models.link.Link

Field Type
id Optional[int]
link_name Optional[str]
link_value Optional[str]
to_concept Optional[str]

LinkCreate

vars_client.generated.oni.models.link_create.LinkCreate

Field Type
concept Optional[str]
link_name Optional[str]
link_value Optional[str]
to_concept Optional[str]

LinkRenameToConceptRequest

vars_client.generated.oni.models.link_rename_to_concept_request.LinkRenameToConceptRequest

Field Type
new Optional[str]
old Optional[str]

LinkRenameToConceptResponse

vars_client.generated.oni.models.link_rename_to_concept_response.LinkRenameToConceptResponse

Field Type
count Optional[int]
new_concept Optional[str]
old_concept Optional[str]

LinkUpdate

vars_client.generated.oni.models.link_update.LinkUpdate

Field Type
link_name Optional[str]
link_value Optional[str]
to_concept Optional[str]

Media

vars_client.generated.oni.models.media.Media

Field Type
caption Optional[str]
concept_name Optional[str]
credit Optional[str]
id Optional[int]
is_primary Optional[bool]
last_updated Optional[str]
mime_type Optional[str]
url Optional[str]

MediaCreate

vars_client.generated.oni.models.media_create.MediaCreate

Field Type
caption Optional[str]
concept_name Optional[str]
credit Optional[str]
is_primary Optional[bool]
media_type Optional[str]
url Optional[str]

MediaUpdate

vars_client.generated.oni.models.media_update.MediaUpdate

Field Type
caption Optional[str]
credit Optional[str]
is_primary Optional[bool]
media_type Optional[str]
url Optional[str]

NotFound

vars_client.generated.oni.models.not_found.NotFound

Field Type
message Optional[str]
response_code Optional[int]

Page_Seq_ExtendedHistory

vars_client.generated.oni.models.page_seq_extended_history.Page_Seq_ExtendedHistory

Field Type
content Optional[list[ExtendedHistory]]
limit Optional[int]
offset Optional[int]

Page_Seq_ExtendedLink

vars_client.generated.oni.models.page_seq_extended_link.Page_Seq_ExtendedLink

Field Type
content Optional[list[ExtendedLink]]
limit Optional[int]
offset Optional[int]

Page_Seq_Reference

vars_client.generated.oni.models.page_seq_reference.Page_Seq_Reference

Field Type
content Optional[list[Reference]]
limit Optional[int]
offset Optional[int]

Page_Seq_String

vars_client.generated.oni.models.page_seq_string.Page_Seq_String

Field Type
content Optional[list[str]]
limit Optional[int]
offset Optional[int]

PrefNode

vars_client.generated.oni.models.pref_node.PrefNode

Field Type
key Optional[str]
name Optional[str]
value Optional[str]

PrefNodeUpdate

vars_client.generated.oni.models.pref_node_update.PrefNodeUpdate

Field Type
key Optional[str]
name Optional[str]
value Optional[str]

Rank

vars_client.generated.oni.models.rank.Rank

Field Type
rank_level Optional[str]
rank_name Optional[str]

RawConcept

vars_client.generated.oni.models.raw_concept.RawConcept

Field Type
aphia_id Optional[int]
children Optional[list[RawConcept]]
id Optional[int]
metadata Optional[RawConceptMetadata]
names Optional[list[RawConceptName]]
rank_level Optional[str]
rank_name Optional[str]

RawConceptMetadata

vars_client.generated.oni.models.raw_concept_metadata.RawConceptMetadata

Field Type
id Optional[int]
link_realizations Optional[list[RawLink]]
link_templates Optional[list[RawLink]]
media Optional[list[RawMedia]]

RawConceptName

vars_client.generated.oni.models.raw_concept_name.RawConceptName

Field Type
author Optional[str]
id Optional[int]
name Optional[str]
name_type Optional[str]

vars_client.generated.oni.models.raw_link.RawLink

Field Type
id Optional[int]
link_name Optional[str]
link_value Optional[str]
to_concept Optional[str]

RawMedia

vars_client.generated.oni.models.raw_media.RawMedia

Field Type
caption Optional[str]
credit Optional[str]
id Optional[int]
primary_media Optional[bool]
type Optional[str]
url Optional[str]

Reference

vars_client.generated.oni.models.reference.Reference

Field Type
citation Optional[str]
concepts Optional[list[str]]
doi Optional[str]
id Optional[int]
last_updated Optional[str]

ReferenceQuery

vars_client.generated.oni.models.reference_query.ReferenceQuery

Field Type
citation Optional[str]
doi Optional[str]

ReferenceUpdate

vars_client.generated.oni.models.reference_update.ReferenceUpdate

Field Type
citation Optional[str]
doi Optional[str]

SerdeConcept

vars_client.generated.oni.models.serde_concept.SerdeConcept

Field Type
alternative_names Optional[list[str]]
aphia_id Optional[int]
children Optional[list[SerdeConcept]]
name Optional[str]
rank Optional[str]

ServerError

vars_client.generated.oni.models.server_error.ServerError

Field Type
message Optional[str]
response_code Optional[int]

Unauthorized

vars_client.generated.oni.models.unauthorized.Unauthorized

Field Type
message Optional[str]
response_code Optional[int]

UserAccount

vars_client.generated.oni.models.user_account.UserAccount

Field Type
affiliation Optional[str]
email Optional[str]
first_name Optional[str]
id Optional[int]
is_encrypted Optional[bool]
last_name Optional[str]
password Optional[str]
role Optional[str]
username Optional[str]

UserAccountCreate

vars_client.generated.oni.models.user_account_create.UserAccountCreate

Field Type
affiliation Optional[str]
email Optional[str]
first_name Optional[str]
last_name Optional[str]
password Optional[str]
role Optional[str]
username Optional[str]

UserAccountUpdate

vars_client.generated.oni.models.user_account_update.UserAccountUpdate

Field Type
affiliation Optional[str]
email Optional[str]
first_name Optional[str]
last_name Optional[str]
password Optional[str]
role Optional[str]