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:

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[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:

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[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:

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[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:

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[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: 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>, revision: str | Unset = <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 (SparseFields | Unset): include (str | Unset): revision (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 | 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: 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>, revision: str | Unset = <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 (SparseFields | Unset): include (str | Unset): revision (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 | 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: 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>, revision: str | Unset = <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 (SparseFields | Unset): include (str | Unset): revision (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 | 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: 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>, revision: str | Unset = <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 (SparseFields | Unset): include (str | Unset): revision (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 | 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: AuthenticatedClient | Client, pagesize: int | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, pagenumber: int | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, 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>, revision: str | Unset = <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 (int | Unset): pagenumber (int | Unset): fields (SparseFields | Unset): include (str | Unset): revision (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 | 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: AuthenticatedClient | Client, pagesize: int | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, pagenumber: int | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, 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>, revision: str | Unset = <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 (int | Unset): pagenumber (int | Unset): fields (SparseFields | Unset): include (str | Unset): revision (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 | 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: AuthenticatedClient | Client, pagesize: int | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, pagenumber: int | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, 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>, revision: str | Unset = <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 (int | Unset): pagenumber (int | Unset): fields (SparseFields | Unset): include (str | Unset): revision (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 | 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: AuthenticatedClient | Client, pagesize: int | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, pagenumber: int | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>, 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>, revision: str | Unset = <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 (int | Unset): pagenumber (int | Unset): fields (SparseFields | Unset): include (str | Unset): revision (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 | 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:

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[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:

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