projects_get_project

Get metadata for a project

Functions

async pydelfini.delfini_core.api.organizational.projects_get_project.asyncio(project_id, *, client)[source]

Get metadata for a project

Retrieve the full metadata for the given project, including any collection IDs for collections that are visible to the current user.

Parameters:
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[Project]

Return type:

Project

async pydelfini.delfini_core.api.organizational.projects_get_project.asyncio_detailed(project_id, *, client)[source]

Get metadata for a project

Retrieve the full metadata for the given project, including any collection IDs for collections that are visible to the current user.

Parameters:
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[Project, ServerError]]

Return type:

Response[Project | ServerError]

pydelfini.delfini_core.api.organizational.projects_get_project.sync(project_id, *, client)[source]

Get metadata for a project

Retrieve the full metadata for the given project, including any collection IDs for collections that are visible to the current user.

Parameters:
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[Project]

Return type:

Project

pydelfini.delfini_core.api.organizational.projects_get_project.sync_detailed(project_id, *, client)[source]

Get metadata for a project

Retrieve the full metadata for the given project, including any collection IDs for collections that are visible to the current user.

Parameters:
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[Project, ServerError]]

Return type:

Response[Project | ServerError]