search_search_dictionaries_by_item¶
Search a data dictionary for data elements compatible with an item’s columns
Functions
- async pydelfini.delfini_core.api.search.search_search_dictionaries_by_item.asyncio(*, client, body)[source]¶
Search a data dictionary for data elements compatible with an item’s columns
This performs a ‘forward search’ for data elements from the provided source that are likely to describe columns in the provided item. The results are returned on a per-column basis, paginated across the columns in the provided item.
The current method uses column names as full-text search queries against the text extracted from the data element definition, including its title, descriptions, and concept codes.
- Parameters:
client (AuthenticatedClient)
- Raises:
errors.UnexpectedStatus – If the server returns a status code greater than or equal to 300.
httpx.TimeoutException – If the request takes longer than Client.timeout.
- Returns:
Union[SearchDictionariesByItemResponse]
- Return type:
- async pydelfini.delfini_core.api.search.search_search_dictionaries_by_item.asyncio_detailed(*, client, body)[source]¶
Search a data dictionary for data elements compatible with an item’s columns
This performs a ‘forward search’ for data elements from the provided source that are likely to describe columns in the provided item. The results are returned on a per-column basis, paginated across the columns in the provided item.
The current method uses column names as full-text search queries against the text extracted from the data element definition, including its title, descriptions, and concept codes.
- Parameters:
client (AuthenticatedClient)
- Raises:
errors.UnexpectedStatus – If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
httpx.TimeoutException – If the request takes longer than Client.timeout.
- Returns:
Response[Union[SearchDictionariesByItemResponse, ServerError]]
- Return type:
- pydelfini.delfini_core.api.search.search_search_dictionaries_by_item.sync(*, client, body)[source]¶
Search a data dictionary for data elements compatible with an item’s columns
This performs a ‘forward search’ for data elements from the provided source that are likely to describe columns in the provided item. The results are returned on a per-column basis, paginated across the columns in the provided item.
The current method uses column names as full-text search queries against the text extracted from the data element definition, including its title, descriptions, and concept codes.
- Parameters:
client (AuthenticatedClient)
- Raises:
errors.UnexpectedStatus – If the server returns a status code greater than or equal to 300.
httpx.TimeoutException – If the request takes longer than Client.timeout.
- Returns:
Union[SearchDictionariesByItemResponse]
- Return type:
- pydelfini.delfini_core.api.search.search_search_dictionaries_by_item.sync_detailed(*, client, body)[source]¶
Search a data dictionary for data elements compatible with an item’s columns
This performs a ‘forward search’ for data elements from the provided source that are likely to describe columns in the provided item. The results are returned on a per-column basis, paginated across the columns in the provided item.
The current method uses column names as full-text search queries against the text extracted from the data element definition, including its title, descriptions, and concept codes.
- Parameters:
client (AuthenticatedClient)
- Raises:
errors.UnexpectedStatus – If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
httpx.TimeoutException – If the request takes longer than Client.timeout.
- Returns:
Response[Union[SearchDictionariesByItemResponse, ServerError]]
- Return type: