polarion_rest_api_client.open_api_client.api.linked_oslc_resources package

Contains endpoint functions for accessing the API.

Submodules

polarion_rest_api_client.open_api_client.api.linked_oslc_resources.delete_oslc_resources module

async polarion_rest_api_client.open_api_client.api.linked_oslc_resources.delete_oslc_resources.asyncio(project_id: str, work_item_id: str, *, client: AuthenticatedClient | Client, body: LinkedoslcresourcesListDeleteRequest) → Any | Errors | None

Deletes a list of instances.

Args:

project_id (str): work_item_id (str): body (LinkedoslcresourcesListDeleteRequest):

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:

Union[Any, Errors]

async polarion_rest_api_client.open_api_client.api.linked_oslc_resources.delete_oslc_resources.asyncio_detailed(project_id: str, work_item_id: str, *, client: AuthenticatedClient | Client, body: LinkedoslcresourcesListDeleteRequest) → Response[Any | Errors]

Deletes a list of instances.

Args:

project_id (str): work_item_id (str): body (LinkedoslcresourcesListDeleteRequest):

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[Any, Errors]]

polarion_rest_api_client.open_api_client.api.linked_oslc_resources.delete_oslc_resources.sync(project_id: str, work_item_id: str, *, client: AuthenticatedClient | Client, body: LinkedoslcresourcesListDeleteRequest) → Any | Errors | None

Deletes a list of instances.

Args:

project_id (str): work_item_id (str): body (LinkedoslcresourcesListDeleteRequest):

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:

Union[Any, Errors]

polarion_rest_api_client.open_api_client.api.linked_oslc_resources.delete_oslc_resources.sync_detailed(project_id: str, work_item_id: str, *, client: AuthenticatedClient | Client, body: LinkedoslcresourcesListDeleteRequest) → Response[Any | Errors]

Deletes a list of instances.

Args:

project_id (str): work_item_id (str): body (LinkedoslcresourcesListDeleteRequest):

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[Any, Errors]]

polarion_rest_api_client.open_api_client.api.linked_oslc_resources.get_oslc_resources module

async polarion_rest_api_client.open_api_client.api.linked_oslc_resources.get_oslc_resources.asyncio(project_id: str, work_item_id: str, *, client: ~polarion_rest_api_client.open_api_client.client.AuthenticatedClient | ~polarion_rest_api_client.open_api_client.client.Client, pagesize: ~polarion_rest_api_client.open_api_client.types.Unset | int = <polarion_rest_api_client.open_api_client.types.Unset object>, pagenumber: ~polarion_rest_api_client.open_api_client.types.Unset | int = <polarion_rest_api_client.open_api_client.types.Unset object>, fields: ~polarion_rest_api_client.open_api_client.types.Unset | ~polarion_rest_api_client.open_api_client.models.sparse_fields.SparseFields = <polarion_rest_api_client.open_api_client.types.Unset object>, include: ~polarion_rest_api_client.open_api_client.types.Unset | str = <polarion_rest_api_client.open_api_client.types.Unset object>, query: ~polarion_rest_api_client.open_api_client.types.Unset | str = <polarion_rest_api_client.open_api_client.types.Unset object>, sort: ~polarion_rest_api_client.open_api_client.types.Unset | str = <polarion_rest_api_client.open_api_client.types.Unset object>, revision: ~polarion_rest_api_client.open_api_client.types.Unset | str = <polarion_rest_api_client.open_api_client.types.Unset object>) → Errors | LinkedoslcresourcesListGetResponse | None

Returns a list of instances.

Args:

project_id (str): work_item_id (str): pagesize (Union[Unset, int]): pagenumber (Union[Unset, int]): fields (Union[Unset, SparseFields]): include (Union[Unset, str]): query (Union[Unset, str]): sort (Union[Unset, str]): revision (Union[Unset, str]):

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:

Union[Errors, LinkedoslcresourcesListGetResponse]

async polarion_rest_api_client.open_api_client.api.linked_oslc_resources.get_oslc_resources.asyncio_detailed(project_id: str, work_item_id: str, *, client: ~polarion_rest_api_client.open_api_client.client.AuthenticatedClient | ~polarion_rest_api_client.open_api_client.client.Client, pagesize: ~polarion_rest_api_client.open_api_client.types.Unset | int = <polarion_rest_api_client.open_api_client.types.Unset object>, pagenumber: ~polarion_rest_api_client.open_api_client.types.Unset | int = <polarion_rest_api_client.open_api_client.types.Unset object>, fields: ~polarion_rest_api_client.open_api_client.types.Unset | ~polarion_rest_api_client.open_api_client.models.sparse_fields.SparseFields = <polarion_rest_api_client.open_api_client.types.Unset object>, include: ~polarion_rest_api_client.open_api_client.types.Unset | str = <polarion_rest_api_client.open_api_client.types.Unset object>, query: ~polarion_rest_api_client.open_api_client.types.Unset | str = <polarion_rest_api_client.open_api_client.types.Unset object>, sort: ~polarion_rest_api_client.open_api_client.types.Unset | str = <polarion_rest_api_client.open_api_client.types.Unset object>, revision: ~polarion_rest_api_client.open_api_client.types.Unset | str = <polarion_rest_api_client.open_api_client.types.Unset object>) → Response[Errors | LinkedoslcresourcesListGetResponse]

Returns a list of instances.

Args:

project_id (str): work_item_id (str): pagesize (Union[Unset, int]): pagenumber (Union[Unset, int]): fields (Union[Unset, SparseFields]): include (Union[Unset, str]): query (Union[Unset, str]): sort (Union[Unset, str]): revision (Union[Unset, str]):

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[Errors, LinkedoslcresourcesListGetResponse]]

polarion_rest_api_client.open_api_client.api.linked_oslc_resources.get_oslc_resources.sync(project_id: str, work_item_id: str, *, client: ~polarion_rest_api_client.open_api_client.client.AuthenticatedClient | ~polarion_rest_api_client.open_api_client.client.Client, pagesize: ~polarion_rest_api_client.open_api_client.types.Unset | int = <polarion_rest_api_client.open_api_client.types.Unset object>, pagenumber: ~polarion_rest_api_client.open_api_client.types.Unset | int = <polarion_rest_api_client.open_api_client.types.Unset object>, fields: ~polarion_rest_api_client.open_api_client.types.Unset | ~polarion_rest_api_client.open_api_client.models.sparse_fields.SparseFields = <polarion_rest_api_client.open_api_client.types.Unset object>, include: ~polarion_rest_api_client.open_api_client.types.Unset | str = <polarion_rest_api_client.open_api_client.types.Unset object>, query: ~polarion_rest_api_client.open_api_client.types.Unset | str = <polarion_rest_api_client.open_api_client.types.Unset object>, sort: ~polarion_rest_api_client.open_api_client.types.Unset | str = <polarion_rest_api_client.open_api_client.types.Unset object>, revision: ~polarion_rest_api_client.open_api_client.types.Unset | str = <polarion_rest_api_client.open_api_client.types.Unset object>) → Errors | LinkedoslcresourcesListGetResponse | None

Returns a list of instances.

Args:

project_id (str): work_item_id (str): pagesize (Union[Unset, int]): pagenumber (Union[Unset, int]): fields (Union[Unset, SparseFields]): include (Union[Unset, str]): query (Union[Unset, str]): sort (Union[Unset, str]): revision (Union[Unset, str]):

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:

Union[Errors, LinkedoslcresourcesListGetResponse]

polarion_rest_api_client.open_api_client.api.linked_oslc_resources.get_oslc_resources.sync_detailed(project_id: str, work_item_id: str, *, client: ~polarion_rest_api_client.open_api_client.client.AuthenticatedClient | ~polarion_rest_api_client.open_api_client.client.Client, pagesize: ~polarion_rest_api_client.open_api_client.types.Unset | int = <polarion_rest_api_client.open_api_client.types.Unset object>, pagenumber: ~polarion_rest_api_client.open_api_client.types.Unset | int = <polarion_rest_api_client.open_api_client.types.Unset object>, fields: ~polarion_rest_api_client.open_api_client.types.Unset | ~polarion_rest_api_client.open_api_client.models.sparse_fields.SparseFields = <polarion_rest_api_client.open_api_client.types.Unset object>, include: ~polarion_rest_api_client.open_api_client.types.Unset | str = <polarion_rest_api_client.open_api_client.types.Unset object>, query: ~polarion_rest_api_client.open_api_client.types.Unset | str = <polarion_rest_api_client.open_api_client.types.Unset object>, sort: ~polarion_rest_api_client.open_api_client.types.Unset | str = <polarion_rest_api_client.open_api_client.types.Unset object>, revision: ~polarion_rest_api_client.open_api_client.types.Unset | str = <polarion_rest_api_client.open_api_client.types.Unset object>) → Response[Errors | LinkedoslcresourcesListGetResponse]

Returns a list of instances.

Args:

project_id (str): work_item_id (str): pagesize (Union[Unset, int]): pagenumber (Union[Unset, int]): fields (Union[Unset, SparseFields]): include (Union[Unset, str]): query (Union[Unset, str]): sort (Union[Unset, str]): revision (Union[Unset, str]):

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[Errors, LinkedoslcresourcesListGetResponse]]

polarion_rest_api_client.open_api_client.api.linked_oslc_resources.post_oslc_resources module

async polarion_rest_api_client.open_api_client.api.linked_oslc_resources.post_oslc_resources.asyncio(project_id: str, work_item_id: str, *, client: AuthenticatedClient | Client, body: LinkedoslcresourcesListPostRequest) → Errors | LinkedoslcresourcesListPostResponse | None

Creates a list of instances.

Args:

project_id (str): work_item_id (str): body (LinkedoslcresourcesListPostRequest):

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:

Union[Errors, LinkedoslcresourcesListPostResponse]

async polarion_rest_api_client.open_api_client.api.linked_oslc_resources.post_oslc_resources.asyncio_detailed(project_id: str, work_item_id: str, *, client: AuthenticatedClient | Client, body: LinkedoslcresourcesListPostRequest) → Response[Errors | LinkedoslcresourcesListPostResponse]

Creates a list of instances.

Args:

project_id (str): work_item_id (str): body (LinkedoslcresourcesListPostRequest):

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[Errors, LinkedoslcresourcesListPostResponse]]

polarion_rest_api_client.open_api_client.api.linked_oslc_resources.post_oslc_resources.sync(project_id: str, work_item_id: str, *, client: AuthenticatedClient | Client, body: LinkedoslcresourcesListPostRequest) → Errors | LinkedoslcresourcesListPostResponse | None

Creates a list of instances.

Args:

project_id (str): work_item_id (str): body (LinkedoslcresourcesListPostRequest):

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:

Union[Errors, LinkedoslcresourcesListPostResponse]

polarion_rest_api_client.open_api_client.api.linked_oslc_resources.post_oslc_resources.sync_detailed(project_id: str, work_item_id: str, *, client: AuthenticatedClient | Client, body: LinkedoslcresourcesListPostRequest) → Response[Errors | LinkedoslcresourcesListPostResponse]

Creates a list of instances.

Args:

project_id (str): work_item_id (str): body (LinkedoslcresourcesListPostRequest):

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[Errors, LinkedoslcresourcesListPostResponse]]