polarion_rest_api_client.open_api_client.api.externally_linked_work_items package

Contains endpoint functions for accessing the API.

Submodules

polarion_rest_api_client.open_api_client.api.externally_linked_work_items.delete_externally_linked_work_item module

async polarion_rest_api_client.open_api_client.api.externally_linked_work_items.delete_externally_linked_work_item.asyncio(project_id: str, work_item_id: str, role_id: str, hostname: str, target_project_id: str, linked_work_item_id: str, *, client: AuthenticatedClient | Client) → Any | Errors | None

Deletes the specified Externally Linked Work Item.

Args:

project_id (str): work_item_id (str): role_id (str): hostname (str): target_project_id (str): linked_work_item_id (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[Any, Errors]

async polarion_rest_api_client.open_api_client.api.externally_linked_work_items.delete_externally_linked_work_item.asyncio_detailed(project_id: str, work_item_id: str, role_id: str, hostname: str, target_project_id: str, linked_work_item_id: str, *, client: AuthenticatedClient | Client) → Response[Any | Errors]

Deletes the specified Externally Linked Work Item.

Args:

project_id (str): work_item_id (str): role_id (str): hostname (str): target_project_id (str): linked_work_item_id (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[Any, Errors]]

polarion_rest_api_client.open_api_client.api.externally_linked_work_items.delete_externally_linked_work_item.sync(project_id: str, work_item_id: str, role_id: str, hostname: str, target_project_id: str, linked_work_item_id: str, *, client: AuthenticatedClient | Client) → Any | Errors | None

Deletes the specified Externally Linked Work Item.

Args:

project_id (str): work_item_id (str): role_id (str): hostname (str): target_project_id (str): linked_work_item_id (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[Any, Errors]

polarion_rest_api_client.open_api_client.api.externally_linked_work_items.delete_externally_linked_work_item.sync_detailed(project_id: str, work_item_id: str, role_id: str, hostname: str, target_project_id: str, linked_work_item_id: str, *, client: AuthenticatedClient | Client) → Response[Any | Errors]

Deletes the specified Externally Linked Work Item.

Args:

project_id (str): work_item_id (str): role_id (str): hostname (str): target_project_id (str): linked_work_item_id (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[Any, Errors]]

polarion_rest_api_client.open_api_client.api.externally_linked_work_items.delete_externally_linked_work_items module

async polarion_rest_api_client.open_api_client.api.externally_linked_work_items.delete_externally_linked_work_items.asyncio(project_id: str, work_item_id: str, *, client: AuthenticatedClient | Client, body: ExternallylinkedworkitemsListDeleteRequest) → Any | Errors | None

Deletes a list of Externally Linked Work Items.

Args:

project_id (str): work_item_id (str): body (ExternallylinkedworkitemsListDeleteRequest):

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.externally_linked_work_items.delete_externally_linked_work_items.asyncio_detailed(project_id: str, work_item_id: str, *, client: AuthenticatedClient | Client, body: ExternallylinkedworkitemsListDeleteRequest) → Response[Any | Errors]

Deletes a list of Externally Linked Work Items.

Args:

project_id (str): work_item_id (str): body (ExternallylinkedworkitemsListDeleteRequest):

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.externally_linked_work_items.delete_externally_linked_work_items.sync(project_id: str, work_item_id: str, *, client: AuthenticatedClient | Client, body: ExternallylinkedworkitemsListDeleteRequest) → Any | Errors | None

Deletes a list of Externally Linked Work Items.

Args:

project_id (str): work_item_id (str): body (ExternallylinkedworkitemsListDeleteRequest):

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.externally_linked_work_items.delete_externally_linked_work_items.sync_detailed(project_id: str, work_item_id: str, *, client: AuthenticatedClient | Client, body: ExternallylinkedworkitemsListDeleteRequest) → Response[Any | Errors]

Deletes a list of Externally Linked Work Items.

Args:

project_id (str): work_item_id (str): body (ExternallylinkedworkitemsListDeleteRequest):

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.externally_linked_work_items.get_externally_linked_work_item module

async polarion_rest_api_client.open_api_client.api.externally_linked_work_items.get_externally_linked_work_item.asyncio(project_id: str, work_item_id: str, role_id: str, hostname: str, target_project_id: str, linked_work_item_id: str, *, client: ~polarion_rest_api_client.open_api_client.client.AuthenticatedClient | ~polarion_rest_api_client.open_api_client.client.Client, 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>, revision: ~polarion_rest_api_client.open_api_client.types.Unset | str = <polarion_rest_api_client.open_api_client.types.Unset object>) → Errors | ExternallylinkedworkitemsSingleGetResponse | None

Returns the specified Externally Linked Work Item.

Returns the external links to other Work Items. (The same as the corresponding Java API method.)

Args:

project_id (str): work_item_id (str): role_id (str): hostname (str): target_project_id (str): linked_work_item_id (str): fields (Union[Unset, SparseFields]): include (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, ExternallylinkedworkitemsSingleGetResponse]

async polarion_rest_api_client.open_api_client.api.externally_linked_work_items.get_externally_linked_work_item.asyncio_detailed(project_id: str, work_item_id: str, role_id: str, hostname: str, target_project_id: str, linked_work_item_id: str, *, client: ~polarion_rest_api_client.open_api_client.client.AuthenticatedClient | ~polarion_rest_api_client.open_api_client.client.Client, 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>, revision: ~polarion_rest_api_client.open_api_client.types.Unset | str = <polarion_rest_api_client.open_api_client.types.Unset object>) → Response[Errors | ExternallylinkedworkitemsSingleGetResponse]

Returns the specified Externally Linked Work Item.

Returns the external links to other Work Items. (The same as the corresponding Java API method.)

Args:

project_id (str): work_item_id (str): role_id (str): hostname (str): target_project_id (str): linked_work_item_id (str): fields (Union[Unset, SparseFields]): include (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, ExternallylinkedworkitemsSingleGetResponse]]

polarion_rest_api_client.open_api_client.api.externally_linked_work_items.get_externally_linked_work_item.sync(project_id: str, work_item_id: str, role_id: str, hostname: str, target_project_id: str, linked_work_item_id: str, *, client: ~polarion_rest_api_client.open_api_client.client.AuthenticatedClient | ~polarion_rest_api_client.open_api_client.client.Client, 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>, revision: ~polarion_rest_api_client.open_api_client.types.Unset | str = <polarion_rest_api_client.open_api_client.types.Unset object>) → Errors | ExternallylinkedworkitemsSingleGetResponse | None

Returns the specified Externally Linked Work Item.

Returns the external links to other Work Items. (The same as the corresponding Java API method.)

Args:

project_id (str): work_item_id (str): role_id (str): hostname (str): target_project_id (str): linked_work_item_id (str): fields (Union[Unset, SparseFields]): include (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, ExternallylinkedworkitemsSingleGetResponse]

polarion_rest_api_client.open_api_client.api.externally_linked_work_items.get_externally_linked_work_item.sync_detailed(project_id: str, work_item_id: str, role_id: str, hostname: str, target_project_id: str, linked_work_item_id: str, *, client: ~polarion_rest_api_client.open_api_client.client.AuthenticatedClient | ~polarion_rest_api_client.open_api_client.client.Client, 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>, revision: ~polarion_rest_api_client.open_api_client.types.Unset | str = <polarion_rest_api_client.open_api_client.types.Unset object>) → Response[Errors | ExternallylinkedworkitemsSingleGetResponse]

Returns the specified Externally Linked Work Item.

Returns the external links to other Work Items. (The same as the corresponding Java API method.)

Args:

project_id (str): work_item_id (str): role_id (str): hostname (str): target_project_id (str): linked_work_item_id (str): fields (Union[Unset, SparseFields]): include (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, ExternallylinkedworkitemsSingleGetResponse]]

polarion_rest_api_client.open_api_client.api.externally_linked_work_items.get_externally_linked_work_items module

async polarion_rest_api_client.open_api_client.api.externally_linked_work_items.get_externally_linked_work_items.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>, revision: ~polarion_rest_api_client.open_api_client.types.Unset | str = <polarion_rest_api_client.open_api_client.types.Unset object>) → Errors | ExternallylinkedworkitemsListGetResponse | None

Returns a list of Externally Linked Work Items.

Returns the external links to other Work Items. (The same as the corresponding Java API method.)

Args:

project_id (str): work_item_id (str): pagesize (Union[Unset, int]): pagenumber (Union[Unset, int]): fields (Union[Unset, SparseFields]): include (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, ExternallylinkedworkitemsListGetResponse]

async polarion_rest_api_client.open_api_client.api.externally_linked_work_items.get_externally_linked_work_items.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>, revision: ~polarion_rest_api_client.open_api_client.types.Unset | str = <polarion_rest_api_client.open_api_client.types.Unset object>) → Response[Errors | ExternallylinkedworkitemsListGetResponse]

Returns a list of Externally Linked Work Items.

Returns the external links to other Work Items. (The same as the corresponding Java API method.)

Args:

project_id (str): work_item_id (str): pagesize (Union[Unset, int]): pagenumber (Union[Unset, int]): fields (Union[Unset, SparseFields]): include (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, ExternallylinkedworkitemsListGetResponse]]

polarion_rest_api_client.open_api_client.api.externally_linked_work_items.get_externally_linked_work_items.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>, revision: ~polarion_rest_api_client.open_api_client.types.Unset | str = <polarion_rest_api_client.open_api_client.types.Unset object>) → Errors | ExternallylinkedworkitemsListGetResponse | None

Returns a list of Externally Linked Work Items.

Returns the external links to other Work Items. (The same as the corresponding Java API method.)

Args:

project_id (str): work_item_id (str): pagesize (Union[Unset, int]): pagenumber (Union[Unset, int]): fields (Union[Unset, SparseFields]): include (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, ExternallylinkedworkitemsListGetResponse]

polarion_rest_api_client.open_api_client.api.externally_linked_work_items.get_externally_linked_work_items.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>, revision: ~polarion_rest_api_client.open_api_client.types.Unset | str = <polarion_rest_api_client.open_api_client.types.Unset object>) → Response[Errors | ExternallylinkedworkitemsListGetResponse]

Returns a list of Externally Linked Work Items.

Returns the external links to other Work Items. (The same as the corresponding Java API method.)

Args:

project_id (str): work_item_id (str): pagesize (Union[Unset, int]): pagenumber (Union[Unset, int]): fields (Union[Unset, SparseFields]): include (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, ExternallylinkedworkitemsListGetResponse]]

polarion_rest_api_client.open_api_client.api.externally_linked_work_items.post_externally_linked_work_items module

async polarion_rest_api_client.open_api_client.api.externally_linked_work_items.post_externally_linked_work_items.asyncio(project_id: str, work_item_id: str, *, client: AuthenticatedClient | Client, body: ExternallylinkedworkitemsListPostRequest) → Errors | ExternallylinkedworkitemsListPostResponse | None

Creates a list of Externally Linked Work Items.

Args:

project_id (str): work_item_id (str): body (ExternallylinkedworkitemsListPostRequest):

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, ExternallylinkedworkitemsListPostResponse]

async polarion_rest_api_client.open_api_client.api.externally_linked_work_items.post_externally_linked_work_items.asyncio_detailed(project_id: str, work_item_id: str, *, client: AuthenticatedClient | Client, body: ExternallylinkedworkitemsListPostRequest) → Response[Errors | ExternallylinkedworkitemsListPostResponse]

Creates a list of Externally Linked Work Items.

Args:

project_id (str): work_item_id (str): body (ExternallylinkedworkitemsListPostRequest):

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, ExternallylinkedworkitemsListPostResponse]]

polarion_rest_api_client.open_api_client.api.externally_linked_work_items.post_externally_linked_work_items.sync(project_id: str, work_item_id: str, *, client: AuthenticatedClient | Client, body: ExternallylinkedworkitemsListPostRequest) → Errors | ExternallylinkedworkitemsListPostResponse | None

Creates a list of Externally Linked Work Items.

Args:

project_id (str): work_item_id (str): body (ExternallylinkedworkitemsListPostRequest):

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, ExternallylinkedworkitemsListPostResponse]

polarion_rest_api_client.open_api_client.api.externally_linked_work_items.post_externally_linked_work_items.sync_detailed(project_id: str, work_item_id: str, *, client: AuthenticatedClient | Client, body: ExternallylinkedworkitemsListPostRequest) → Response[Errors | ExternallylinkedworkitemsListPostResponse]

Creates a list of Externally Linked Work Items.

Args:

project_id (str): work_item_id (str): body (ExternallylinkedworkitemsListPostRequest):

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, ExternallylinkedworkitemsListPostResponse]]