Organizations

OrganizationsFilters

Bases: BaseModel

Filter model for the Organizations V3 endpoint (/v3/organizations).

Attributes:

Name	Type	Description
search	str | None	Search term for the organization.
legalName	str | None	Legal name of the organization.
legalShortName	str | None	Legal short name of the organization.
id	str | None	OpenAIRE id for the organization.
pid	str | None	Persistent identifier for the organization.
countryCode	str | None	Country code of the organization.
relCommunityId	str | None	Related community ID.
relCollectedFromDatasourceId	str | None	ID of the datasource from which this was collected.
logicalOperator	Literal['AND', 'OR', 'NOT'] | None	How multiple filters are combined (default: AND).

Source code in src/aireloom/endpoints.py

class OrganizationsFilters(BaseModel):
    """Filter model for the Organizations V3 endpoint (``/v3/organizations``).

    Attributes:
        search (str | None): Search term for the organization.
        legalName (str | None): Legal name of the organization.
        legalShortName (str | None): Legal short name of the organization.
        id (str | None): OpenAIRE id for the organization.
        pid (str | None): Persistent identifier for the organization.
        countryCode (str | None): Country code of the organization.
        relCommunityId (str | None): Related community ID.
        relCollectedFromDatasourceId (str | None): ID of the datasource from which this was collected.
        logicalOperator (Literal["AND", "OR", "NOT"] | None): How multiple filters are combined (default: AND).
    """

    search: str | None = None
    legalName: str | None = None
    legalShortName: str | None = None
    id: str | None = None
    pid: str | None = None
    countryCode: str | None = None
    relCommunityId: str | None = None
    relCollectedFromDatasourceId: str | None = None
    logicalOperator: Literal["AND", "OR", "NOT"] | None = None

    model_config = ConfigDict(extra="forbid")

countryCode = None class-attribute instance-attribute

id = None class-attribute instance-attribute

legalName = None class-attribute instance-attribute

legalShortName = None class-attribute instance-attribute

logicalOperator = None class-attribute instance-attribute

model_config = ConfigDict(extra='forbid') class-attribute instance-attribute

pid = None class-attribute instance-attribute

relCollectedFromDatasourceId = None class-attribute instance-attribute

relCommunityId = None class-attribute instance-attribute

search = None class-attribute instance-attribute

OrganizationsClient

Bases: StandardResourceClient

Client for the OpenAIRE Organizations API endpoint.

Attributes:

Name	Type	Description
_entity_path	str	The API path for organizations.
_entity_model	type[Organization]	Pydantic model for a single organization.
_search_response_model	type[OrganizationResponse]	Pydantic model for the search response envelope.

Source code in src/aireloom/resources/organizations_client.py

class OrganizationsClient(StandardResourceClient):
    """Client for the OpenAIRE Organizations API endpoint.

    Attributes:
        _entity_path (str): The API path for organizations.
        _entity_model (type[Organization]): Pydantic model for a single organization.
        _search_response_model (type[OrganizationResponse]): Pydantic model for the
                                                              search response envelope.
    """

    _entity_path: str = ORGANIZATIONS
    _entity_model: type[Organization] = Organization
    _search_response_model: type[OrganizationResponse] = OrganizationResponse
    _batch_fields: dict[str, str] = {
        "pid": "pid",
        "openaire_id": "id",
    }