aiida_restapi package

Subpackages

• aiida_restapi.cli package
  • Submodules
  • aiida_restapi.cli.main module
  • Module contents
• aiida_restapi.common package
  • Submodules
  • aiida_restapi.common.exceptions module
    • JsonApiException
      • JsonApiException.__module__
      • JsonApiException.__weakref__
    • QueryBuilderException
      • QueryBuilderException.__module__
      • QueryBuilderException.__weakref__
    • SchemaNotSupported
      • SchemaNotSupported.__module__
      • SchemaNotSupported.__weakref__
  • aiida_restapi.common.pagination module
    • PaginatedResults
      • PaginatedResults.__abstractmethods__
      • PaginatedResults.__annotations__
      • PaginatedResults.__class_vars__
      • PaginatedResults.__dict__
      • PaginatedResults.__module__
      • PaginatedResults.__orig_bases__
      • PaginatedResults.__parameters__
      • PaginatedResults.__private_attributes__
      • PaginatedResults.__pydantic_complete__
      • PaginatedResults.__pydantic_computed_fields__
      • PaginatedResults.__pydantic_core_schema__
      • PaginatedResults.__pydantic_custom_init__
      • PaginatedResults.__pydantic_decorators__
      • PaginatedResults.__pydantic_extra__
      • PaginatedResults.__pydantic_extra_info__
      • PaginatedResults.__pydantic_fields__
      • PaginatedResults.__pydantic_fields_set__
      • PaginatedResults.__pydantic_generic_metadata__
      • PaginatedResults.__pydantic_parent_namespace__
      • PaginatedResults.__pydantic_post_init__
      • PaginatedResults.__pydantic_private__
      • PaginatedResults.__pydantic_serializer__
      • PaginatedResults.__pydantic_setattr_handlers__
      • PaginatedResults.__pydantic_validator__
      • PaginatedResults.__signature__
      • PaginatedResults.__weakref__
      • PaginatedResults._abc_impl
      • PaginatedResults.data
      • PaginatedResults.model_config
      • PaginatedResults.page
      • PaginatedResults.page_size
      • PaginatedResults.total
  • aiida_restapi.common.query module
    • CollectionQueryParams
      • CollectionQueryParams.__abstractmethods__
      • CollectionQueryParams.__annotations__
      • CollectionQueryParams.__class_vars__
      • CollectionQueryParams.__dict__
      • CollectionQueryParams.__module__
      • CollectionQueryParams.__private_attributes__
      • CollectionQueryParams.__pydantic_complete__
      • CollectionQueryParams.__pydantic_computed_fields__
      • CollectionQueryParams.__pydantic_core_schema__
      • CollectionQueryParams.__pydantic_custom_init__
      • CollectionQueryParams.__pydantic_decorators__
      • CollectionQueryParams.__pydantic_extra__
      • CollectionQueryParams.__pydantic_extra_info__
      • CollectionQueryParams.__pydantic_fields__
      • CollectionQueryParams.__pydantic_fields_set__
      • CollectionQueryParams.__pydantic_generic_metadata__
      • CollectionQueryParams.__pydantic_parent_namespace__
      • CollectionQueryParams.__pydantic_post_init__
      • CollectionQueryParams.__pydantic_private__
      • CollectionQueryParams.__pydantic_serializer__
      • CollectionQueryParams.__pydantic_setattr_handlers__
      • CollectionQueryParams.__pydantic_validator__
      • CollectionQueryParams.__signature__
      • CollectionQueryParams._abc_impl
      • CollectionQueryParams.model_config
    • QueryBuilderParams
      • QueryBuilderParams.__abstractmethods__
      • QueryBuilderParams.__annotations__
      • QueryBuilderParams.__class_vars__
      • QueryBuilderParams.__dict__
      • QueryBuilderParams.__module__
      • QueryBuilderParams.__private_attributes__
      • QueryBuilderParams.__pydantic_complete__
      • QueryBuilderParams.__pydantic_computed_fields__
      • QueryBuilderParams.__pydantic_core_schema__
      • QueryBuilderParams.__pydantic_custom_init__
      • QueryBuilderParams.__pydantic_decorators__
      • QueryBuilderParams.__pydantic_extra__
      • QueryBuilderParams.__pydantic_extra_info__
      • QueryBuilderParams.__pydantic_fields__
      • QueryBuilderParams.__pydantic_fields_set__
      • QueryBuilderParams.__pydantic_generic_metadata__
      • QueryBuilderParams.__pydantic_parent_namespace__
      • QueryBuilderParams.__pydantic_post_init__
      • QueryBuilderParams.__pydantic_private__
      • QueryBuilderParams.__pydantic_serializer__
      • QueryBuilderParams.__pydantic_setattr_handlers__
      • QueryBuilderParams.__pydantic_validator__
      • QueryBuilderParams.__signature__
      • QueryBuilderParams._abc_impl
      • QueryBuilderParams.model_config
    • ResourceQueryParams
      • ResourceQueryParams.__abstractmethods__
      • ResourceQueryParams.__annotations__
      • ResourceQueryParams.__class_vars__
      • ResourceQueryParams.__dict__
      • ResourceQueryParams.__module__
      • ResourceQueryParams.__private_attributes__
      • ResourceQueryParams.__pydantic_complete__
      • ResourceQueryParams.__pydantic_computed_fields__
      • ResourceQueryParams.__pydantic_core_schema__
      • ResourceQueryParams.__pydantic_custom_init__
      • ResourceQueryParams.__pydantic_decorators__
      • ResourceQueryParams.__pydantic_extra__
      • ResourceQueryParams.__pydantic_extra_info__
      • ResourceQueryParams.__pydantic_fields__
      • ResourceQueryParams.__pydantic_fields_set__
      • ResourceQueryParams.__pydantic_generic_metadata__
      • ResourceQueryParams.__pydantic_parent_namespace__
      • ResourceQueryParams.__pydantic_post_init__
      • ResourceQueryParams.__pydantic_private__
      • ResourceQueryParams.__pydantic_serializer__
      • ResourceQueryParams.__pydantic_setattr_handlers__
      • ResourceQueryParams.__pydantic_validator__
      • ResourceQueryParams.__signature__
      • ResourceQueryParams._abc_impl
      • ResourceQueryParams.model_config
    • collection_query_params()
    • querybuilder_params()
    • resource_query_params()
  • aiida_restapi.common.types module
  • Module contents
• aiida_restapi.graphql package
  • Submodules
  • aiida_restapi.graphql.aiida_db_mappings module
    • AuthInfo
      • AuthInfo.__abstractmethods__
      • AuthInfo.__annotations__
      • AuthInfo.__class_vars__
      • AuthInfo.__dict__
      • AuthInfo.__module__
      • AuthInfo.__private_attributes__
      • AuthInfo.__pydantic_complete__
      • AuthInfo.__pydantic_computed_fields__
      • AuthInfo.__pydantic_core_schema__
      • AuthInfo.__pydantic_custom_init__
      • AuthInfo.__pydantic_decorators__
      • AuthInfo.__pydantic_extra__
      • AuthInfo.__pydantic_extra_info__
      • AuthInfo.__pydantic_fields__
      • AuthInfo.__pydantic_fields_set__
      • AuthInfo.__pydantic_generic_metadata__
      • AuthInfo.__pydantic_parent_namespace__
      • AuthInfo.__pydantic_post_init__
      • AuthInfo.__pydantic_private__
      • AuthInfo.__pydantic_serializer__
      • AuthInfo.__pydantic_setattr_handlers__
      • AuthInfo.__pydantic_validator__
      • AuthInfo.__signature__
      • AuthInfo.__weakref__
      • AuthInfo._abc_impl
      • AuthInfo.aiidauser_id
      • AuthInfo.auth_params
      • AuthInfo.dbcomputer_id
      • AuthInfo.enabled
      • AuthInfo.id
      • AuthInfo.metadata
      • AuthInfo.model_config
    • Comment
      • Comment.__abstractmethods__
      • Comment.__annotations__
      • Comment.__class_vars__
      • Comment.__dict__
      • Comment.__module__
      • Comment.__private_attributes__
      • Comment.__pydantic_complete__
      • Comment.__pydantic_computed_fields__
      • Comment.__pydantic_core_schema__
      • Comment.__pydantic_custom_init__
      • Comment.__pydantic_decorators__
      • Comment.__pydantic_extra__
      • Comment.__pydantic_extra_info__
      • Comment.__pydantic_fields__
      • Comment.__pydantic_fields_set__
      • Comment.__pydantic_generic_metadata__
      • Comment.__pydantic_parent_namespace__
      • Comment.__pydantic_post_init__
      • Comment.__pydantic_private__
      • Comment.__pydantic_serializer__
      • Comment.__pydantic_setattr_handlers__
      • Comment.__pydantic_validator__
      • Comment.__signature__
      • Comment.__weakref__
      • Comment._abc_impl
      • Comment.content
      • Comment.ctime
      • Comment.dbnode_id
      • Comment.id
      • Comment.model_config
      • Comment.mtime
      • Comment.user_id
      • Comment.uuid
    • Computer
      • Computer.__abstractmethods__
      • Computer.__annotations__
      • Computer.__class_vars__
      • Computer.__dict__
      • Computer.__module__
      • Computer.__private_attributes__
      • Computer.__pydantic_complete__
      • Computer.__pydantic_computed_fields__
      • Computer.__pydantic_core_schema__
      • Computer.__pydantic_custom_init__
      • Computer.__pydantic_decorators__
      • Computer.__pydantic_extra__
      • Computer.__pydantic_extra_info__
      • Computer.__pydantic_fields__
      • Computer.__pydantic_fields_set__
      • Computer.__pydantic_generic_metadata__
      • Computer.__pydantic_parent_namespace__
      • Computer.__pydantic_post_init__
      • Computer.__pydantic_private__
      • Computer.__pydantic_serializer__
      • Computer.__pydantic_setattr_handlers__
      • Computer.__pydantic_validator__
      • Computer.__signature__
      • Computer.__weakref__
      • Computer._abc_impl
      • Computer.description
      • Computer.hostname
      • Computer.id
      • Computer.label
      • Computer.metadata
      • Computer.model_config
      • Computer.scheduler_type
      • Computer.transport_type
      • Computer.uuid
    • Group
      • Group.__abstractmethods__
      • Group.__annotations__
      • Group.__class_vars__
      • Group.__dict__
      • Group.__module__
      • Group.__private_attributes__
      • Group.__pydantic_complete__
      • Group.__pydantic_computed_fields__
      • Group.__pydantic_core_schema__
      • Group.__pydantic_custom_init__
      • Group.__pydantic_decorators__
      • Group.__pydantic_extra__
      • Group.__pydantic_extra_info__
      • Group.__pydantic_fields__
      • Group.__pydantic_fields_set__
      • Group.__pydantic_generic_metadata__
      • Group.__pydantic_parent_namespace__
      • Group.__pydantic_post_init__
      • Group.__pydantic_private__
      • Group.__pydantic_serializer__
      • Group.__pydantic_setattr_handlers__
      • Group.__pydantic_validator__
      • Group.__signature__
      • Group.__weakref__
      • Group._abc_impl
      • Group.description
      • Group.extras
      • Group.id
      • Group.label
      • Group.model_config
      • Group.time
      • Group.type_string
      • Group.user_id
      • Group.uuid
    • Link
      • Link.__abstractmethods__
      • Link.__annotations__
      • Link.__class_vars__
      • Link.__dict__
      • Link.__module__
      • Link.__private_attributes__
      • Link.__pydantic_complete__
      • Link.__pydantic_computed_fields__
      • Link.__pydantic_core_schema__
      • Link.__pydantic_custom_init__
      • Link.__pydantic_decorators__
      • Link.__pydantic_extra__
      • Link.__pydantic_extra_info__
      • Link.__pydantic_fields__
      • Link.__pydantic_fields_set__
      • Link.__pydantic_generic_metadata__
      • Link.__pydantic_parent_namespace__
      • Link.__pydantic_post_init__
      • Link.__pydantic_private__
      • Link.__pydantic_serializer__
      • Link.__pydantic_setattr_handlers__
      • Link.__pydantic_validator__
      • Link.__signature__
      • Link.__weakref__
      • Link._abc_impl
      • Link.id
      • Link.input_id
      • Link.label
      • Link.model_config
      • Link.output_id
      • Link.type
    • Log
      • Log.__abstractmethods__
      • Log.__annotations__
      • Log.__class_vars__
      • Log.__dict__
      • Log.__module__
      • Log.__private_attributes__
      • Log.__pydantic_complete__
      • Log.__pydantic_computed_fields__
      • Log.__pydantic_core_schema__
      • Log.__pydantic_custom_init__
      • Log.__pydantic_decorators__
      • Log.__pydantic_extra__
      • Log.__pydantic_extra_info__
      • Log.__pydantic_fields__
      • Log.__pydantic_fields_set__
      • Log.__pydantic_generic_metadata__
      • Log.__pydantic_parent_namespace__
      • Log.__pydantic_post_init__
      • Log.__pydantic_private__
      • Log.__pydantic_serializer__
      • Log.__pydantic_setattr_handlers__
      • Log.__pydantic_validator__
      • Log.__signature__
      • Log.__weakref__
      • Log._abc_impl
      • Log.dbnode_id
      • Log.id
      • Log.levelname
      • Log.loggername
      • Log.message
      • Log.metadata
      • Log.model_config
      • Log.time
      • Log.uuid
    • Node
      • Node.__abstractmethods__
      • Node.__annotations__
      • Node.__class_vars__
      • Node.__dict__
      • Node.__module__
      • Node.__private_attributes__
      • Node.__pydantic_complete__
      • Node.__pydantic_computed_fields__
      • Node.__pydantic_core_schema__
      • Node.__pydantic_custom_init__
      • Node.__pydantic_decorators__
      • Node.__pydantic_extra__
      • Node.__pydantic_extra_info__
      • Node.__pydantic_fields__
      • Node.__pydantic_fields_set__
      • Node.__pydantic_generic_metadata__
      • Node.__pydantic_parent_namespace__
      • Node.__pydantic_post_init__
      • Node.__pydantic_private__
      • Node.__pydantic_serializer__
      • Node.__pydantic_setattr_handlers__
      • Node.__pydantic_validator__
      • Node.__signature__
      • Node.__weakref__
      • Node._abc_impl
      • Node.attributes
      • Node.ctime
      • Node.dbcomputer_id
      • Node.description
      • Node.extras
      • Node.id
      • Node.label
      • Node.model_config
      • Node.mtime
      • Node.node_type
      • Node.process_type
      • Node.user_id
      • Node.uuid
    • User
      • User.__abstractmethods__
      • User.__annotations__
      • User.__class_vars__
      • User.__dict__
      • User.__module__
      • User.__private_attributes__
      • User.__pydantic_complete__
      • User.__pydantic_computed_fields__
      • User.__pydantic_core_schema__
      • User.__pydantic_custom_init__
      • User.__pydantic_decorators__
      • User.__pydantic_extra__
      • User.__pydantic_extra_info__
      • User.__pydantic_fields__
      • User.__pydantic_fields_set__
      • User.__pydantic_generic_metadata__
      • User.__pydantic_parent_namespace__
      • User.__pydantic_post_init__
      • User.__pydantic_private__
      • User.__pydantic_serializer__
      • User.__pydantic_setattr_handlers__
      • User.__pydantic_validator__
      • User.__signature__
      • User.__weakref__
      • User._abc_impl
      • User.email
      • User.first_name
      • User.id
      • User.institution
      • User.last_name
      • User.model_config
    • get_model_from_orm()
  • aiida_restapi.graphql.basic module
    • resolve_aiidaVersion()
    • resolve_rowLimitMax()
  • aiida_restapi.graphql.comments module
    • CommentQuery
      • CommentQuery.__module__
      • CommentQuery._meta
    • CommentsQuery
      • CommentsQuery.__annotations__
      • CommentsQuery.__module__
      • CommentsQuery._meta
    • resolve_Comment()
    • resolve_Comments()
  • aiida_restapi.graphql.computers module
    • ComputerQuery
      • ComputerQuery.__annotations__
      • ComputerQuery.__module__
      • ComputerQuery._meta
      • ComputerQuery.nodes
      • ComputerQuery.resolve_nodes()
    • ComputersQuery
      • ComputersQuery.__annotations__
      • ComputersQuery.__module__
      • ComputersQuery._meta
    • resolve_Computer()
    • resolve_Computers()
  • aiida_restapi.graphql.config module
    • ENTITY_LIMIT
  • aiida_restapi.graphql.entry_points module
    • EntryPoints
      • EntryPoints.__annotations__
      • EntryPoints.__module__
      • EntryPoints._meta
      • EntryPoints.group
      • EntryPoints.names
    • resolve_aiidaEntryPointGroups()
    • resolve_aiidaEntryPoints()
  • aiida_restapi.graphql.filter_syntax module
    • _parse_value()
    • _parse_valuelist()
    • parse_filter_str()
  • aiida_restapi.graphql.groups module
    • GroupQuery
      • GroupQuery.__annotations__
      • GroupQuery.__module__
      • GroupQuery._meta
      • GroupQuery.nodes
      • GroupQuery.resolve_nodes()
    • GroupsQuery
      • GroupsQuery.__annotations__
      • GroupsQuery.__module__
      • GroupsQuery._meta
    • resolve_Group()
    • resolve_Groups()
  • aiida_restapi.graphql.logs module
    • LogQuery
      • LogQuery.__annotations__
      • LogQuery.__module__
      • LogQuery._meta
    • LogsQuery
      • LogsQuery.__annotations__
      • LogsQuery.__module__
      • LogsQuery._meta
    • resolve_Log()
    • resolve_Logs()
  • aiida_restapi.graphql.main module
  • aiida_restapi.graphql.nodes module
    • LinkQuery
      • LinkQuery.__annotations__
      • LinkQuery.__module__
      • LinkQuery._meta
      • LinkQuery.link
      • LinkQuery.node
    • LinksQuery
      • LinksQuery.__annotations__
      • LinksQuery.__module__
      • LinksQuery._meta
    • NodeQuery
      • NodeQuery.__annotations__
      • NodeQuery.__module__
      • NodeQuery._meta
      • NodeQuery.ancestors
      • NodeQuery.attributes
      • NodeQuery.comments
      • NodeQuery.descendants
      • NodeQuery.extras
      • NodeQuery.incoming
      • NodeQuery.logs
      • NodeQuery.outgoing
      • NodeQuery.resolve_ancestors()
      • NodeQuery.resolve_attributes()
      • NodeQuery.resolve_comments()
      • NodeQuery.resolve_descendants()
      • NodeQuery.resolve_extras()
      • NodeQuery.resolve_incoming()
      • NodeQuery.resolve_logs()
      • NodeQuery.resolve_outgoing()
    • NodesQuery
      • NodesQuery.__annotations__
      • NodesQuery.__module__
      • NodesQuery._meta
    • resolve_Node()
    • resolve_Nodes()
  • aiida_restapi.graphql.orm_factories module
    • create_query_path()
    • field_names_from_orm()
    • fields_from_name()
    • fields_from_orm()
    • get_projection()
    • get_pydantic_type_name()
    • multirow_cls_factory()
    • resolve_entity()
    • single_cls_factory()
  • aiida_restapi.graphql.plugins module
    • QueryPlugin
      • QueryPlugin.__annotations__
      • QueryPlugin.__getnewargs__()
      • QueryPlugin.__match_args__
      • QueryPlugin.__module__
      • QueryPlugin.__new__()
      • QueryPlugin.__orig_bases__
      • QueryPlugin.__repr__()
      • QueryPlugin.__slots__
      • QueryPlugin._asdict()
      • QueryPlugin._field_defaults
      • QueryPlugin._fields
      • QueryPlugin._make()
      • QueryPlugin._replace()
      • QueryPlugin.field
      • QueryPlugin.name
      • QueryPlugin.resolver
    • create_query()
    • create_schema()
  • aiida_restapi.graphql.sphinx_ext module
    • setup()
  • aiida_restapi.graphql.users module
    • UserQuery
      • UserQuery.__annotations__
      • UserQuery.__module__
      • UserQuery._meta
      • UserQuery.nodes
      • UserQuery.resolve_nodes()
    • UsersQuery
      • UsersQuery.__annotations__
      • UsersQuery.__module__
      • UsersQuery._meta
    • resolve_User()
    • resolve_Users()
  • aiida_restapi.graphql.utils module
    • FilterString
      • FilterString.__annotations__
      • FilterString.__module__
      • FilterString._meta
    • JSON
      • JSON.__annotations__
      • JSON.__module__
      • JSON._meta
    • selected_field_names_naive()
  • Module contents
• aiida_restapi.jsonapi package
  • Submodules
  • aiida_restapi.jsonapi.adapters module
    • JsonApiAdapter
      • JsonApiAdapter.BASE_API_URL
      • JsonApiAdapter.HOOKS
      • JsonApiAdapter.RESOURCE_TYPES
      • JsonApiAdapter.__annotations__
      • JsonApiAdapter.__dict__
      • JsonApiAdapter.__module__
      • JsonApiAdapter.__weakref__
      • JsonApiAdapter._base_api_url()
      • JsonApiAdapter._build_link()
      • JsonApiAdapter._build_resource()
      • JsonApiAdapter._build_toplevel_links()
      • JsonApiAdapter._hook_for()
      • JsonApiAdapter._to_child_resource()
      • JsonApiAdapter._to_resource()
      • JsonApiAdapter.child_resource()
      • JsonApiAdapter.collection()
      • JsonApiAdapter.register_hooks()
      • JsonApiAdapter.resource()
  • aiida_restapi.jsonapi.hooks module
    • BaseHook
      • BaseHook.FOREIGN_FIELDS
      • BaseHook.INCLUDED_TYPE_MAP
      • BaseHook.TYPE_MAP
      • BaseHook.__annotations__
      • BaseHook.__dict__
      • BaseHook.__module__
      • BaseHook.__weakref__
      • BaseHook._build_included_item()
      • BaseHook.include()
      • BaseHook.links()
      • BaseHook.relationships()
      • BaseHook.split_resource()
    • ComputerHook
      • ComputerHook.__annotations__
      • ComputerHook.__module__
      • ComputerHook.relationships()
    • EntityHook
      • EntityHook.INCLUDED_TYPE_MAP
      • EntityHook.TYPE_MAP
      • EntityHook.__annotations__
      • EntityHook.__module__
    • GroupHook
      • GroupHook.FOREIGN_FIELDS
      • GroupHook.__annotations__
      • GroupHook.__module__
      • GroupHook.relationships()
    • LinkHook
      • LinkHook.FOREIGN_FIELDS
      • LinkHook.INCLUDED_TYPE_MAP
      • LinkHook.__annotations__
      • LinkHook.__module__
      • LinkHook.relationships()
    • NodeHook
      • NodeHook.FOREIGN_FIELDS
      • NodeHook.__annotations__
      • NodeHook.__module__
      • NodeHook.relationships()
    • ResourceHook
      • ResourceHook.__annotations__
      • ResourceHook.__module__
      • ResourceHook.links()
      • ResourceHook.relationships()
  • aiida_restapi.jsonapi.responses module
    • JsonApiResponse
      • JsonApiResponse.__module__
      • JsonApiResponse.media_type
      • JsonApiResponse.render()
  • aiida_restapi.jsonapi.utils module
    • IncludedItemParamsCache
      • IncludedItemParamsCache.__annotations__
      • IncludedItemParamsCache.__dataclass_fields__
      • IncludedItemParamsCache.__dataclass_params__
      • IncludedItemParamsCache.__dict__
      • IncludedItemParamsCache.__eq__()
      • IncludedItemParamsCache.__hash__
      • IncludedItemParamsCache.__init__()
      • IncludedItemParamsCache.__match_args__
      • IncludedItemParamsCache.__module__
      • IncludedItemParamsCache.__repr__()
      • IncludedItemParamsCache.__weakref__
      • IncludedItemParamsCache.bucket()
      • IncludedItemParamsCache.buckets
    • jsonapi_error()
  • Module contents
• aiida_restapi.models package
  • Submodules
  • aiida_restapi.models.node module
    • NodeLink
      • NodeLink.__abstractmethods__
      • NodeLink.__annotations__
      • NodeLink.__class_vars__
      • NodeLink.__dict__
      • NodeLink.__module__
      • NodeLink.__private_attributes__
      • NodeLink.__pydantic_complete__
      • NodeLink.__pydantic_computed_fields__
      • NodeLink.__pydantic_core_schema__
      • NodeLink.__pydantic_custom_init__
      • NodeLink.__pydantic_decorators__
      • NodeLink.__pydantic_extra__
      • NodeLink.__pydantic_extra_info__
      • NodeLink.__pydantic_fields__
      • NodeLink.__pydantic_fields_set__
      • NodeLink.__pydantic_generic_metadata__
      • NodeLink.__pydantic_parent_namespace__
      • NodeLink.__pydantic_post_init__
      • NodeLink.__pydantic_private__
      • NodeLink.__pydantic_serializer__
      • NodeLink.__pydantic_setattr_handlers__
      • NodeLink.__pydantic_validator__
      • NodeLink.__signature__
      • NodeLink.__weakref__
      • NodeLink._abc_impl
      • NodeLink.link_id
      • NodeLink.link_label
      • NodeLink.link_type
      • NodeLink.model_config
      • NodeLink.source
      • NodeLink.target
    • NodeModelRegistry
      • NodeModelRegistry.__dict__
      • NodeModelRegistry.__init__()
      • NodeModelRegistry.__module__
      • NodeModelRegistry.__weakref__
      • NodeModelRegistry._build_model_union()
      • NodeModelRegistry._build_node_mappings()
      • NodeModelRegistry.get_model()
      • NodeModelRegistry.get_node_class_name()
      • NodeModelRegistry.get_node_types()
      • NodeModelRegistry.get_post_model_from_payload()
    • NodeStatistics
      • NodeStatistics.__abstractmethods__
      • NodeStatistics.__annotations__
      • NodeStatistics.__class_vars__
      • NodeStatistics.__dict__
      • NodeStatistics.__module__
      • NodeStatistics.__private_attributes__
      • NodeStatistics.__pydantic_complete__
      • NodeStatistics.__pydantic_computed_fields__
      • NodeStatistics.__pydantic_core_schema__
      • NodeStatistics.__pydantic_custom_init__
      • NodeStatistics.__pydantic_decorators__
      • NodeStatistics.__pydantic_extra__
      • NodeStatistics.__pydantic_extra_info__
      • NodeStatistics.__pydantic_fields__
      • NodeStatistics.__pydantic_fields_set__
      • NodeStatistics.__pydantic_generic_metadata__
      • NodeStatistics.__pydantic_parent_namespace__
      • NodeStatistics.__pydantic_post_init__
      • NodeStatistics.__pydantic_private__
      • NodeStatistics.__pydantic_serializer__
      • NodeStatistics.__pydantic_setattr_handlers__
      • NodeStatistics.__pydantic_validator__
      • NodeStatistics.__signature__
      • NodeStatistics.__weakref__
      • NodeStatistics._abc_impl
      • NodeStatistics.ctime_by_day
      • NodeStatistics.model_config
      • NodeStatistics.total
      • NodeStatistics.types
    • NodeType
      • NodeType.__abstractmethods__
      • NodeType.__annotations__
      • NodeType.__class_vars__
      • NodeType.__dict__
      • NodeType.__module__
      • NodeType.__private_attributes__
      • NodeType.__pydantic_complete__
      • NodeType.__pydantic_computed_fields__
      • NodeType.__pydantic_core_schema__
      • NodeType.__pydantic_custom_init__
      • NodeType.__pydantic_decorators__
      • NodeType.__pydantic_extra__
      • NodeType.__pydantic_extra_info__
      • NodeType.__pydantic_fields__
      • NodeType.__pydantic_fields_set__
      • NodeType.__pydantic_generic_metadata__
      • NodeType.__pydantic_parent_namespace__
      • NodeType.__pydantic_post_init__
      • NodeType.__pydantic_private__
      • NodeType.__pydantic_serializer__
      • NodeType.__pydantic_setattr_handlers__
      • NodeType.__pydantic_validator__
      • NodeType.__signature__
      • NodeType.__weakref__
      • NodeType._abc_impl
      • NodeType.label
      • NodeType.model_config
      • NodeType.node_schema
      • NodeType.node_type
      • NodeType.nodes
      • NodeType.projections
    • RepoDirMetadata
      • RepoDirMetadata.__abstractmethods__
      • RepoDirMetadata.__annotations__
      • RepoDirMetadata.__class_vars__
      • RepoDirMetadata.__dict__
      • RepoDirMetadata.__module__
      • RepoDirMetadata.__private_attributes__
      • RepoDirMetadata.__pydantic_complete__
      • RepoDirMetadata.__pydantic_computed_fields__
      • RepoDirMetadata.__pydantic_core_schema__
      • RepoDirMetadata.__pydantic_custom_init__
      • RepoDirMetadata.__pydantic_decorators__
      • RepoDirMetadata.__pydantic_extra__
      • RepoDirMetadata.__pydantic_extra_info__
      • RepoDirMetadata.__pydantic_fields__
      • RepoDirMetadata.__pydantic_fields_set__
      • RepoDirMetadata.__pydantic_generic_metadata__
      • RepoDirMetadata.__pydantic_parent_namespace__
      • RepoDirMetadata.__pydantic_post_init__
      • RepoDirMetadata.__pydantic_private__
      • RepoDirMetadata.__pydantic_serializer__
      • RepoDirMetadata.__pydantic_setattr_handlers__
      • RepoDirMetadata.__pydantic_validator__
      • RepoDirMetadata.__signature__
      • RepoDirMetadata.__weakref__
      • RepoDirMetadata._abc_impl
      • RepoDirMetadata.file_type
      • RepoDirMetadata.model_config
      • RepoDirMetadata.objects
    • RepoFileMetadata
      • RepoFileMetadata.__abstractmethods__
      • RepoFileMetadata.__annotations__
      • RepoFileMetadata.__class_vars__
      • RepoFileMetadata.__dict__
      • RepoFileMetadata.__module__
      • RepoFileMetadata.__private_attributes__
      • RepoFileMetadata.__pydantic_complete__
      • RepoFileMetadata.__pydantic_computed_fields__
      • RepoFileMetadata.__pydantic_core_schema__
      • RepoFileMetadata.__pydantic_custom_init__
      • RepoFileMetadata.__pydantic_decorators__
      • RepoFileMetadata.__pydantic_extra__
      • RepoFileMetadata.__pydantic_extra_info__
      • RepoFileMetadata.__pydantic_fields__
      • RepoFileMetadata.__pydantic_fields_set__
      • RepoFileMetadata.__pydantic_generic_metadata__
      • RepoFileMetadata.__pydantic_parent_namespace__
      • RepoFileMetadata.__pydantic_post_init__
      • RepoFileMetadata.__pydantic_private__
      • RepoFileMetadata.__pydantic_serializer__
      • RepoFileMetadata.__pydantic_setattr_handlers__
      • RepoFileMetadata.__pydantic_validator__
      • RepoFileMetadata.__signature__
      • RepoFileMetadata.__weakref__
      • RepoFileMetadata._abc_impl
      • RepoFileMetadata.binary
      • RepoFileMetadata.download
      • RepoFileMetadata.file_hash
      • RepoFileMetadata.file_type
      • RepoFileMetadata.model_config
      • RepoFileMetadata.size
  • aiida_restapi.models.querybuilder module
    • QueryBuilderDict
      • QueryBuilderDict.__abstractmethods__
      • QueryBuilderDict.__annotations__
      • QueryBuilderDict.__class_vars__
      • QueryBuilderDict.__dict__
      • QueryBuilderDict.__module__
      • QueryBuilderDict.__private_attributes__
      • QueryBuilderDict.__pydantic_complete__
      • QueryBuilderDict.__pydantic_computed_fields__
      • QueryBuilderDict.__pydantic_core_schema__
      • QueryBuilderDict.__pydantic_custom_init__
      • QueryBuilderDict.__pydantic_decorators__
      • QueryBuilderDict.__pydantic_extra__
      • QueryBuilderDict.__pydantic_extra_info__
      • QueryBuilderDict.__pydantic_fields__
      • QueryBuilderDict.__pydantic_fields_set__
      • QueryBuilderDict.__pydantic_generic_metadata__
      • QueryBuilderDict.__pydantic_parent_namespace__
      • QueryBuilderDict.__pydantic_post_init__
      • QueryBuilderDict.__pydantic_private__
      • QueryBuilderDict.__pydantic_serializer__
      • QueryBuilderDict.__pydantic_setattr_handlers__
      • QueryBuilderDict.__pydantic_validator__
      • QueryBuilderDict.__signature__
      • QueryBuilderDict.__weakref__
      • QueryBuilderDict._abc_impl
      • QueryBuilderDict.distinct
      • QueryBuilderDict.filters
      • QueryBuilderDict.limit
      • QueryBuilderDict.model_config
      • QueryBuilderDict.offset
      • QueryBuilderDict.order_by
      • QueryBuilderDict.path
      • QueryBuilderDict.project
    • QueryBuilderPathItem
      • QueryBuilderPathItem.__abstractmethods__
      • QueryBuilderPathItem.__annotations__
      • QueryBuilderPathItem.__class_vars__
      • QueryBuilderPathItem.__dict__
      • QueryBuilderPathItem.__module__
      • QueryBuilderPathItem.__private_attributes__
      • QueryBuilderPathItem.__pydantic_complete__
      • QueryBuilderPathItem.__pydantic_computed_fields__
      • QueryBuilderPathItem.__pydantic_core_schema__
      • QueryBuilderPathItem.__pydantic_custom_init__
      • QueryBuilderPathItem.__pydantic_decorators__
      • QueryBuilderPathItem.__pydantic_extra__
      • QueryBuilderPathItem.__pydantic_extra_info__
      • QueryBuilderPathItem.__pydantic_fields__
      • QueryBuilderPathItem.__pydantic_fields_set__
      • QueryBuilderPathItem.__pydantic_generic_metadata__
      • QueryBuilderPathItem.__pydantic_parent_namespace__
      • QueryBuilderPathItem.__pydantic_post_init__
      • QueryBuilderPathItem.__pydantic_private__
      • QueryBuilderPathItem.__pydantic_serializer__
      • QueryBuilderPathItem.__pydantic_setattr_handlers__
      • QueryBuilderPathItem.__pydantic_validator__
      • QueryBuilderPathItem.__signature__
      • QueryBuilderPathItem.__weakref__
      • QueryBuilderPathItem._abc_impl
      • QueryBuilderPathItem.edge_tag
      • QueryBuilderPathItem.entity_type
      • QueryBuilderPathItem.joining_keyword
      • QueryBuilderPathItem.joining_value
      • QueryBuilderPathItem.model_config
      • QueryBuilderPathItem.orm_base
      • QueryBuilderPathItem.outerjoin
      • QueryBuilderPathItem.tag
  • aiida_restapi.models.server module
    • ServerEndpoint
      • ServerEndpoint.__abstractmethods__
      • ServerEndpoint.__annotations__
      • ServerEndpoint.__class_vars__
      • ServerEndpoint.__dict__
      • ServerEndpoint.__module__
      • ServerEndpoint.__private_attributes__
      • ServerEndpoint.__pydantic_complete__
      • ServerEndpoint.__pydantic_computed_fields__
      • ServerEndpoint.__pydantic_core_schema__
      • ServerEndpoint.__pydantic_custom_init__
      • ServerEndpoint.__pydantic_decorators__
      • ServerEndpoint.__pydantic_extra__
      • ServerEndpoint.__pydantic_extra_info__
      • ServerEndpoint.__pydantic_fields__
      • ServerEndpoint.__pydantic_fields_set__
      • ServerEndpoint.__pydantic_generic_metadata__
      • ServerEndpoint.__pydantic_parent_namespace__
      • ServerEndpoint.__pydantic_post_init__
      • ServerEndpoint.__pydantic_private__
      • ServerEndpoint.__pydantic_serializer__
      • ServerEndpoint.__pydantic_setattr_handlers__
      • ServerEndpoint.__pydantic_validator__
      • ServerEndpoint.__signature__
      • ServerEndpoint.__weakref__
      • ServerEndpoint._abc_impl
      • ServerEndpoint.description
      • ServerEndpoint.group
      • ServerEndpoint.methods
      • ServerEndpoint.model_config
      • ServerEndpoint.path
    • ServerInfo
      • ServerInfo.__abstractmethods__
      • ServerInfo.__annotations__
      • ServerInfo.__class_vars__
      • ServerInfo.__dict__
      • ServerInfo.__module__
      • ServerInfo.__private_attributes__
      • ServerInfo.__pydantic_complete__
      • ServerInfo.__pydantic_computed_fields__
      • ServerInfo.__pydantic_core_schema__
      • ServerInfo.__pydantic_custom_init__
      • ServerInfo.__pydantic_decorators__
      • ServerInfo.__pydantic_extra__
      • ServerInfo.__pydantic_extra_info__
      • ServerInfo.__pydantic_fields__
      • ServerInfo.__pydantic_fields_set__
      • ServerInfo.__pydantic_generic_metadata__
      • ServerInfo.__pydantic_parent_namespace__
      • ServerInfo.__pydantic_post_init__
      • ServerInfo.__pydantic_private__
      • ServerInfo.__pydantic_serializer__
      • ServerInfo.__pydantic_setattr_handlers__
      • ServerInfo.__pydantic_validator__
      • ServerInfo.__signature__
      • ServerInfo.__weakref__
      • ServerInfo._abc_impl
      • ServerInfo.aiida_version
      • ServerInfo.api_major_version
      • ServerInfo.api_minor_version
      • ServerInfo.api_prefix
      • ServerInfo.api_revision_version
      • ServerInfo.model_config
  • Module contents
• aiida_restapi.routers package
  • Subpackages
    • aiida_restapi.routers.tests package
      • Submodules
      • aiida_restapi.routers.tests.tests module
      • Module contents
  • Submodules
  • aiida_restapi.routers.auth module
    • Token
      • Token.__abstractmethods__
      • Token.__annotations__
      • Token.__class_vars__
      • Token.__dict__
      • Token.__module__
      • Token.__private_attributes__
      • Token.__pydantic_complete__
      • Token.__pydantic_computed_fields__
      • Token.__pydantic_core_schema__
      • Token.__pydantic_custom_init__
      • Token.__pydantic_decorators__
      • Token.__pydantic_extra__
      • Token.__pydantic_extra_info__
      • Token.__pydantic_fields__
      • Token.__pydantic_fields_set__
      • Token.__pydantic_generic_metadata__
      • Token.__pydantic_parent_namespace__
      • Token.__pydantic_post_init__
      • Token.__pydantic_private__
      • Token.__pydantic_serializer__
      • Token.__pydantic_setattr_handlers__
      • Token.__pydantic_validator__
      • Token.__signature__
      • Token.__weakref__
      • Token._abc_impl
      • Token.access_token
      • Token.model_config
      • Token.token_type
    • TokenData
      • TokenData.__abstractmethods__
      • TokenData.__annotations__
      • TokenData.__class_vars__
      • TokenData.__dict__
      • TokenData.__module__
      • TokenData.__private_attributes__
      • TokenData.__pydantic_complete__
      • TokenData.__pydantic_computed_fields__
      • TokenData.__pydantic_core_schema__
      • TokenData.__pydantic_custom_init__
      • TokenData.__pydantic_decorators__
      • TokenData.__pydantic_extra__
      • TokenData.__pydantic_extra_info__
      • TokenData.__pydantic_fields__
      • TokenData.__pydantic_fields_set__
      • TokenData.__pydantic_generic_metadata__
      • TokenData.__pydantic_parent_namespace__
      • TokenData.__pydantic_post_init__
      • TokenData.__pydantic_private__
      • TokenData.__pydantic_serializer__
      • TokenData.__pydantic_setattr_handlers__
      • TokenData.__pydantic_validator__
      • TokenData.__signature__
      • TokenData.__weakref__
      • TokenData._abc_impl
      • TokenData.email
      • TokenData.model_config
    • UserInDB
      • UserInDB.__abstractmethods__
      • UserInDB.__annotations__
      • UserInDB.__class_vars__
      • UserInDB.__dict__
      • UserInDB.__module__
      • UserInDB.__private_attributes__
      • UserInDB.__pydantic_complete__
      • UserInDB.__pydantic_computed_fields__
      • UserInDB.__pydantic_core_schema__
      • UserInDB.__pydantic_custom_init__
      • UserInDB.__pydantic_decorators__
      • UserInDB.__pydantic_extra__
      • UserInDB.__pydantic_extra_info__
      • UserInDB.__pydantic_fields__
      • UserInDB.__pydantic_fields_set__
      • UserInDB.__pydantic_generic_metadata__
      • UserInDB.__pydantic_parent_namespace__
      • UserInDB.__pydantic_post_init__
      • UserInDB.__pydantic_private__
      • UserInDB.__pydantic_serializer__
      • UserInDB.__pydantic_setattr_handlers__
      • UserInDB.__pydantic_validator__
      • UserInDB._abc_impl
      • UserInDB.disabled
      • UserInDB.hashed_password
      • UserInDB.model_config
    • authenticate_user()
    • create_access_token()
    • get_current_active_user()
    • get_current_user()
    • get_password_hash()
    • get_user()
    • login_for_access_token()
    • read_users_me()
    • verify_password()
  • aiida_restapi.routers.computers module
    • create_computer()
    • get_computer()
    • get_computer_metadata()
    • get_computer_projections()
    • get_computers()
    • get_computers_schema()
  • aiida_restapi.routers.daemon module
    • DaemonStatusModel
      • DaemonStatusModel.__abstractmethods__
      • DaemonStatusModel.__annotations__
      • DaemonStatusModel.__class_vars__
      • DaemonStatusModel.__dict__
      • DaemonStatusModel.__module__
      • DaemonStatusModel.__private_attributes__
      • DaemonStatusModel.__pydantic_complete__
      • DaemonStatusModel.__pydantic_computed_fields__
      • DaemonStatusModel.__pydantic_core_schema__
      • DaemonStatusModel.__pydantic_custom_init__
      • DaemonStatusModel.__pydantic_decorators__
      • DaemonStatusModel.__pydantic_extra__
      • DaemonStatusModel.__pydantic_extra_info__
      • DaemonStatusModel.__pydantic_fields__
      • DaemonStatusModel.__pydantic_fields_set__
      • DaemonStatusModel.__pydantic_generic_metadata__
      • DaemonStatusModel.__pydantic_parent_namespace__
      • DaemonStatusModel.__pydantic_post_init__
      • DaemonStatusModel.__pydantic_private__
      • DaemonStatusModel.__pydantic_serializer__
      • DaemonStatusModel.__pydantic_setattr_handlers__
      • DaemonStatusModel.__pydantic_validator__
      • DaemonStatusModel.__signature__
      • DaemonStatusModel.__weakref__
      • DaemonStatusModel._abc_impl
      • DaemonStatusModel.model_config
      • DaemonStatusModel.num_workers
      • DaemonStatusModel.running
    • get_daemon_start()
    • get_daemon_status()
    • get_daemon_stop()
  • aiida_restapi.routers.groups module
    • create_group()
    • get_group()
    • get_group_extras()
    • get_group_nodes()
    • get_group_projections()
    • get_group_user()
    • get_groups()
    • get_groups_schema()
  • aiida_restapi.routers.nodes module
    • create_node()
    • create_node_constructor()
    • create_node_with_files()
    • download_node()
    • get_file_download_headers()
    • get_node()
    • get_node_attributes()
    • get_node_computer()
    • get_node_extras()
    • get_node_groups()
    • get_node_links()
    • get_node_projections()
    • get_node_repo_file_contents()
    • get_node_repo_file_metadata()
    • get_node_types()
    • get_node_user()
    • get_nodes()
    • get_nodes_download_formats()
    • get_nodes_schema()
    • get_nodes_statistics()
    • stream_bytes()
    • unsupported_model_error_handler()
    • update_node()
  • aiida_restapi.routers.querybuilder module
    • _to_resource_result()
    • query_builder()
  • aiida_restapi.routers.server module
    • _get_route_parts()
    • get_server_endpoints()
    • get_server_endpoints_table()
    • get_server_info()
  • aiida_restapi.routers.submit module
    • ProcessSubmitModel
      • ProcessSubmitModel.__abstractmethods__
      • ProcessSubmitModel.__annotations__
      • ProcessSubmitModel.__class_vars__
      • ProcessSubmitModel.__dict__
      • ProcessSubmitModel.__module__
      • ProcessSubmitModel.__private_attributes__
      • ProcessSubmitModel.__pydantic_complete__
      • ProcessSubmitModel.__pydantic_computed_fields__
      • ProcessSubmitModel.__pydantic_core_schema__
      • ProcessSubmitModel.__pydantic_custom_init__
      • ProcessSubmitModel.__pydantic_decorators__
      • ProcessSubmitModel.__pydantic_extra__
      • ProcessSubmitModel.__pydantic_extra_info__
      • ProcessSubmitModel.__pydantic_fields__
      • ProcessSubmitModel.__pydantic_fields_set__
      • ProcessSubmitModel.__pydantic_generic_metadata__
      • ProcessSubmitModel.__pydantic_parent_namespace__
      • ProcessSubmitModel.__pydantic_post_init__
      • ProcessSubmitModel.__pydantic_private__
      • ProcessSubmitModel.__pydantic_serializer__
      • ProcessSubmitModel.__pydantic_setattr_handlers__
      • ProcessSubmitModel.__pydantic_validator__
      • ProcessSubmitModel.__signature__
      • ProcessSubmitModel.__weakref__
      • ProcessSubmitModel._abc_impl
      • ProcessSubmitModel.entry_point
      • ProcessSubmitModel.inputs
      • ProcessSubmitModel.label
      • ProcessSubmitModel.model_config
      • ProcessSubmitModel.process_inputs()
    • process_inputs()
    • submit_process()
  • aiida_restapi.routers.users module
    • create_user()
    • get_user()
    • get_user_projections()
    • get_users()
    • get_users_schema()
  • Module contents
• aiida_restapi.services package
  • Submodules
  • aiida_restapi.services.entity module
    • EntityService
      • EntityService.__annotations__
      • EntityService.__dict__
      • EntityService.__init__()
      • EntityService.__module__
      • EntityService.__orig_bases__
      • EntityService.__parameters__
      • EntityService.__weakref__
      • EntityService._apply_update()
      • EntityService._get_projections()
      • EntityService.add()
      • EntityService.get_field()
      • EntityService.get_many()
      • EntityService.get_one()
      • EntityService.get_projections()
      • EntityService.get_related_many()
      • EntityService.get_related_one()
      • EntityService.get_schema()
      • EntityService.project
      • EntityService.update()
  • aiida_restapi.services.node module
    • NodeService
      • NodeService.DEFAULT_NAMESPACE_LABEL
      • NodeService.FULL_TYPE_CONCATENATOR
      • NodeService.LIKE_OPERATOR_CHARACTER
      • NodeService.__annotations__
      • NodeService.__module__
      • NodeService.__orig_bases__
      • NodeService.__parameters__
      • NodeService._apply_update()
      • NodeService._construct_full_type()
      • NodeService._get_full_type_filters()
      • NodeService._load_entry_point_from_full_type()
      • NodeService._load_entry_point_from_node_type()
      • NodeService._validate_full_type()
      • NodeService.add()
      • NodeService.get_download_formats()
      • NodeService.get_links()
      • NodeService.get_projections()
      • NodeService.get_repository_metadata()
      • NodeService.with_key
  • Module contents
• aiida_restapi.static package
  • Module contents

Submodules

aiida_restapi.config module

Configuration of API

aiida_restapi.main module

Declaration of FastAPI application.

aiida_restapi.main.create_app()

Create the FastAPI application and include the routers.

Returns:

The FastAPI application.

Return type:

FastAPI

aiida_restapi.utils module

General utility functions.

aiida_restapi.utils.parse_date(string)

Parse any date/time stamp string.

Module contents

AiiDA REST API for data queries and workflow management.