Models¶
Pydantic v2 models for all Crucible API objects. Import them from crucible.models. The core record models (Project, Dataset, Sample, Instrument, User, PublicUser, InstrumentReference, ProjectReference, ResourceCapabilities, EffectiveResourceAccess) are also importable directly from crucible.
from crucible.models import Dataset, Sample, Project, Instrument, InstrumentReference, ProjectReference, User, PublicUser, ResourceCapabilities, DeletionRequest, FacetResponse
crucible.models.Project
¶
crucible.models.Dataset
¶
crucible.models.InstrumentReference
¶
Lightweight instrument identity embedded in dataset responses.
crucible.models.ProjectReference
¶
Lightweight project identity embedded in dataset responses.
crucible.models.Sample
¶
crucible.models.Instrument
¶
crucible.models.User
¶
crucible.models.PublicUser
¶
Public-safe user record embedded in resource responses.
crucible.models.ResourceCapabilities
¶
Caller-specific actions available for an exact resource response.
crucible.models.EffectiveResourceAccess
¶
A user's effective permission on one resource.
crucible.models.FacetBucket
¶
One grouped value and its count from a facet response.
Owner, project, and instrument facets also carry a typed reference object under the matching key, preserved by extra='allow'.
crucible.models.FacetResponse
¶
A page of facet buckets for one grouping field.
crucible.models.ServiceAccountAdmin
¶
A service account as seen by an administrator, with role and key state.
crucible.models.ServiceAccountKeyStatus
¶
Issue and expiry state of a service account's current API key.
crucible.models.EntryCapabilities
¶
What the caller may do to one access entry or group member.
can_remove: the matching DELETE would succeed. can_change_role: a role change would succeed for at least one other role, listed in assignable_roles. All are false for callers who can only view access.
crucible.models.DeletionRequest
¶
A pending or resolved request to delete a resource.
crucible.models.DeletionRequestCapabilities
¶
What the calling user may do with a deletion request.
crucible.models.JoinRequest
¶
A pending or closed request to join a project.
crucible.models.JoinRequestCapabilities
¶
What the calling user may do with a join request.
crucible.models.Pipeline
¶
A postprocessing pipeline that can run on a dataset.
crucible.models.PostprocessingRun
¶
One run of a postprocessing pipeline on a dataset.