polarion_rest_api_client.open_api_client.api.work_item_comments package

Contains endpoint functions for accessing the API.

Submodules

polarion_rest_api_client.open_api_client.api.work_item_comments.get_comment module

async polarion_rest_api_client.open_api_client.api.work_item_comments.get_comment.asyncio(project_id: str, work_item_id: str, comment_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 | WorkitemCommentsSingleGetResponse | None

Returns the specified Work Item Comment.

Args:

project_id (str): work_item_id (str): comment_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, WorkitemCommentsSingleGetResponse]

async polarion_rest_api_client.open_api_client.api.work_item_comments.get_comment.asyncio_detailed(project_id: str, work_item_id: str, comment_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 | WorkitemCommentsSingleGetResponse]

Returns the specified Work Item Comment.

Args:

project_id (str): work_item_id (str): comment_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, WorkitemCommentsSingleGetResponse]]

polarion_rest_api_client.open_api_client.api.work_item_comments.get_comment.sync(project_id: str, work_item_id: str, comment_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 | WorkitemCommentsSingleGetResponse | None

Returns the specified Work Item Comment.

Args:

project_id (str): work_item_id (str): comment_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, WorkitemCommentsSingleGetResponse]

polarion_rest_api_client.open_api_client.api.work_item_comments.get_comment.sync_detailed(project_id: str, work_item_id: str, comment_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 | WorkitemCommentsSingleGetResponse]

Returns the specified Work Item Comment.

Args:

project_id (str): work_item_id (str): comment_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, WorkitemCommentsSingleGetResponse]]

polarion_rest_api_client.open_api_client.api.work_item_comments.get_comments module

async polarion_rest_api_client.open_api_client.api.work_item_comments.get_comments.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 | WorkitemCommentsListGetResponse | None

Returns a list of Work Item Comments.

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

async polarion_rest_api_client.open_api_client.api.work_item_comments.get_comments.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 | WorkitemCommentsListGetResponse]

Returns a list of Work Item Comments.

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

polarion_rest_api_client.open_api_client.api.work_item_comments.get_comments.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 | WorkitemCommentsListGetResponse | None

Returns a list of Work Item Comments.

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

polarion_rest_api_client.open_api_client.api.work_item_comments.get_comments.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 | WorkitemCommentsListGetResponse]

Returns a list of Work Item Comments.

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

polarion_rest_api_client.open_api_client.api.work_item_comments.patch_comment module

async polarion_rest_api_client.open_api_client.api.work_item_comments.patch_comment.asyncio(project_id: str, work_item_id: str, comment_id: str, *, client: AuthenticatedClient | Client, body: WorkitemCommentsSinglePatchRequest) → Any | Errors | None

Updates the specified Work Item Comment.

Args:

project_id (str): work_item_id (str): comment_id (str): body (WorkitemCommentsSinglePatchRequest):

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

Updates the specified Work Item Comment.

Args:

project_id (str): work_item_id (str): comment_id (str): body (WorkitemCommentsSinglePatchRequest):

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.work_item_comments.patch_comment.sync(project_id: str, work_item_id: str, comment_id: str, *, client: AuthenticatedClient | Client, body: WorkitemCommentsSinglePatchRequest) → Any | Errors | None

Updates the specified Work Item Comment.

Args:

project_id (str): work_item_id (str): comment_id (str): body (WorkitemCommentsSinglePatchRequest):

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

Updates the specified Work Item Comment.

Args:

project_id (str): work_item_id (str): comment_id (str): body (WorkitemCommentsSinglePatchRequest):

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.work_item_comments.post_comments module

async polarion_rest_api_client.open_api_client.api.work_item_comments.post_comments.asyncio(project_id: str, work_item_id: str, *, client: AuthenticatedClient | Client, body: WorkitemCommentsListPostRequest) → Errors | WorkitemCommentsListPostResponse | None

Creates a list of Work Item Comments.

Args:

project_id (str): work_item_id (str): body (WorkitemCommentsListPostRequest):

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

async polarion_rest_api_client.open_api_client.api.work_item_comments.post_comments.asyncio_detailed(project_id: str, work_item_id: str, *, client: AuthenticatedClient | Client, body: WorkitemCommentsListPostRequest) → Response[Errors | WorkitemCommentsListPostResponse]

Creates a list of Work Item Comments.

Args:

project_id (str): work_item_id (str): body (WorkitemCommentsListPostRequest):

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

polarion_rest_api_client.open_api_client.api.work_item_comments.post_comments.sync(project_id: str, work_item_id: str, *, client: AuthenticatedClient | Client, body: WorkitemCommentsListPostRequest) → Errors | WorkitemCommentsListPostResponse | None

Creates a list of Work Item Comments.

Args:

project_id (str): work_item_id (str): body (WorkitemCommentsListPostRequest):

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

polarion_rest_api_client.open_api_client.api.work_item_comments.post_comments.sync_detailed(project_id: str, work_item_id: str, *, client: AuthenticatedClient | Client, body: WorkitemCommentsListPostRequest) → Response[Errors | WorkitemCommentsListPostResponse]

Creates a list of Work Item Comments.

Args:

project_id (str): work_item_id (str): body (WorkitemCommentsListPostRequest):

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