polarion_rest_api_client.open_api_client.api.roles package

Contains endpoint functions for accessing the API

Submodules

polarion_rest_api_client.open_api_client.api.roles.get_role module

async polarion_rest_api_client.open_api_client.api.roles.get_role.asyncio(role_id: str, *, client: AuthenticatedClient | Client, fields: SparseFields | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, include: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>) → Errors | GlobalrolesSingleGetResponse | None

Returns the specified Global Role.

Args:

role_id (str): fields (SparseFields | Unset): include (str | Unset):

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:

Errors | GlobalrolesSingleGetResponse

async polarion_rest_api_client.open_api_client.api.roles.get_role.asyncio_detailed(role_id: str, *, client: AuthenticatedClient | Client, fields: SparseFields | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, include: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>) → Response[Errors | GlobalrolesSingleGetResponse]

Returns the specified Global Role.

Args:

role_id (str): fields (SparseFields | Unset): include (str | Unset):

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[Errors | GlobalrolesSingleGetResponse]

polarion_rest_api_client.open_api_client.api.roles.get_role.sync(role_id: str, *, client: AuthenticatedClient | Client, fields: SparseFields | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, include: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>) → Errors | GlobalrolesSingleGetResponse | None

Returns the specified Global Role.

Args:

role_id (str): fields (SparseFields | Unset): include (str | Unset):

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:

Errors | GlobalrolesSingleGetResponse

polarion_rest_api_client.open_api_client.api.roles.get_role.sync_detailed(role_id: str, *, client: AuthenticatedClient | Client, fields: SparseFields | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, include: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>) → Response[Errors | GlobalrolesSingleGetResponse]

Returns the specified Global Role.

Args:

role_id (str): fields (SparseFields | Unset): include (str | Unset):

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[Errors | GlobalrolesSingleGetResponse]