mex.backend.publishable_merged package

Submodules

mex.backend.publishable_merged.helpers module

mex.backend.publishable_merged.helpers.merge_publishable_search_result_item(item: dict[str, Any], publishing_target: PublishingTarget) → MergedAccessPlatform | MergedActivity | MergedBibliographicResource | MergedConsent | MergedContactPoint | MergedDistribution | MergedOrganization | MergedOrganizationalUnit | MergedPerson | MergedPrimarySource | MergedResource | MergedVariable | MergedVariableGroup | None

Merge a single search result into a merged item.

Parameters:

  • item – Raw merged search result item from the graph response

  • validation – Merged items validate the existence of required fields and the lengths of lists by default, set this to LENIENT to avoid this and return a “preview” of a merged item instead of a valid merged item, or set this to IGNORE to return None in case of validation errors.

  • publishing_target – Target to which the items are published.

Raises:

MergingError – When the given items cannot be merged

Returns:

Instance of a merged or preview item

mex.backend.publishable_merged.helpers.search_publishable_merged_items_in_graph(*, query_string: str | None = None, identifier: str | None = None, entity_type: Sequence[__annotationlib_name_1__] | None = None, reference_filters: Sequence[ReferenceFilter] | None = None, skip: int = 0, limit: int = 100, publishing_target: PublishingTarget) → PaginatedItemsContainer[MergedAccessPlatform | MergedActivity | MergedBibliographicResource | MergedConsent | MergedContactPoint | MergedDistribution | MergedOrganization | MergedOrganizationalUnit | MergedPerson | MergedPrimarySource | MergedResource | MergedVariable | MergedVariableGroup]

Search for merged items.

Parameters:

  • query_string – Full text search query term

  • identifier – Optional merged item identifier filter

  • entity_type – Optional entity type filter

  • reference_filters – Optional reference field filters

  • skip – How many items to skip for pagination

  • limit – How many items to return at most

  • publishing_target – Target to which the items are published.

Raises:

MergingError – When the given items cannot be merged

Returns:

Search response for preview or merged items

mex.backend.publishable_merged.main module

mex.backend.publishable_merged.main.search_publishable_merged_items(publishingTarget: Annotated[PublishingTarget, Query(PydanticUndefined)], 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[MergedAccessPlatform | MergedActivity | MergedBibliographicResource | MergedConsent | MergedContactPoint | MergedDistribution | MergedOrganization | MergedOrganizationalUnit | MergedPerson | MergedPrimarySource | MergedResource | MergedVariable | MergedVariableGroup]

Search for publishable merged items using simple filters.

For complex queries combining multiple reference filters, use POST /publishable-merged-item/_search

mex.backend.publishable_merged.main.search_publishable_merged_items_advanced(publishingTarget: Annotated[PublishingTarget, Body(PydanticUndefined)], 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[MergedAccessPlatform | MergedActivity | MergedBibliographicResource | MergedConsent | MergedContactPoint | MergedDistribution | MergedOrganization | MergedOrganizationalUnit | MergedPerson | MergedPrimarySource | MergedResource | MergedVariable | MergedVariableGroup]

Search for publishable merged items with advanced filter combinations.

Use this endpoint for: - Multiple reference filters combined with AND logic, e.g. hadPrimarySource AND

unitOf

Module contents