mex.backend.preview package¶
Submodules¶
mex.backend.preview.main module¶
- mex.backend.preview.main.get_preview_item(identifier: Annotated[Identifier, Path(PydanticUndefined)]) PreviewAccessPlatform | PreviewActivity | PreviewBibliographicResource | PreviewConsent | PreviewContactPoint | PreviewDistribution | PreviewOrganization | PreviewOrganizationalUnit | PreviewPerson | PreviewPrimarySource | PreviewResource | PreviewVariable | PreviewVariableGroup¶
Get the preview for an item by its identifier.
- mex.backend.preview.main.search_preview_items(q: Annotated[str, Query(PydanticUndefined)] = '', identifier: Annotated[Identifier | None, Query(PydanticUndefined)] = None, entityType: Annotated[Sequence[MergedType], Query(PydanticUndefined)] = [], referencedIdentifier: Annotated[Sequence[Identifier] | None, Query(PydanticUndefined)] = None, referenceField: Annotated[ReferenceFieldName | None, Query(PydanticUndefined)] = None, skip: Annotated[int, Query(PydanticUndefined)] = 0, limit: Annotated[int, Query(PydanticUndefined)] = 10) PaginatedItemsContainer[PreviewAccessPlatform | PreviewActivity | PreviewBibliographicResource | PreviewConsent | PreviewContactPoint | PreviewDistribution | PreviewOrganization | PreviewOrganizationalUnit | PreviewPerson | PreviewPrimarySource | PreviewResource | PreviewVariable | PreviewVariableGroup]¶
Search for merged item previews using simple filters.
For complex queries combining multiple reference filters, use POST /preview-item/_search
In contrast to /merged-item, this endpoint does not validate the existence of required fields or the length restrictions of lists.
- mex.backend.preview.main.search_preview_items_advanced(q: Annotated[str, Body(PydanticUndefined)] = '', identifier: Annotated[Identifier | None, Body(PydanticUndefined)] = None, entityType: Annotated[Sequence[MergedType], Body(PydanticUndefined)] = [], referenceFilters: Annotated[Sequence[ReferenceFilter], Body(PydanticUndefined)] | None = None, skip: Annotated[int, Body(PydanticUndefined)] = 0, limit: Annotated[int, Body(PydanticUndefined)] = 10) PaginatedItemsContainer[PreviewAccessPlatform | PreviewActivity | PreviewBibliographicResource | PreviewConsent | PreviewContactPoint | PreviewDistribution | PreviewOrganization | PreviewOrganizationalUnit | PreviewPerson | PreviewPrimarySource | PreviewResource | PreviewVariable | PreviewVariableGroup]¶
Search for merged item previews with advanced filter combinations.
Use this endpoint for: - Multiple reference filters combined with AND logic, e.g. hadPrimarySource AND
unitOf
In contrast to /merged-item/_search, this endpoint does not validate the existence of required fields or the length restrictions of lists.