polarion_rest_api_client.open_api_client.api.page_attachments package¶

Contains endpoint functions for accessing the API

Submodules¶

polarion_rest_api_client.open_api_client.api.page_attachments.delete_page_attachment module¶

async polarion_rest_api_client.open_api_client.api.page_attachments.delete_page_attachment.asyncio(project_id: str, space_id: str, page_name: str, attachment_id: str, *, client: AuthenticatedClient | Client) → Any | Errors | None¶

Deletes the specified Page Attachment.

Args:: project_id (str): space_id (str): page_name (str): attachment_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.page_attachments.delete_page_attachment.asyncio_detailed(project_id: str, space_id: str, page_name: str, attachment_id: str, *, client: AuthenticatedClient | Client) → Response[Any | Errors]¶

Deletes the specified Page Attachment.

Args:: project_id (str): space_id (str): page_name (str): attachment_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.page_attachments.delete_page_attachment.sync(project_id: str, space_id: str, page_name: str, attachment_id: str, *, client: AuthenticatedClient | Client) → Any | Errors | None¶

Deletes the specified Page Attachment.

Args:: project_id (str): space_id (str): page_name (str): attachment_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.page_attachments.delete_page_attachment.sync_detailed(project_id: str, space_id: str, page_name: str, attachment_id: str, *, client: AuthenticatedClient | Client) → Response[Any | Errors]¶

Deletes the specified Page Attachment.

Args:: project_id (str): space_id (str): page_name (str): attachment_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.page_attachments.get_page_attachment module¶

async polarion_rest_api_client.open_api_client.api.page_attachments.get_page_attachment.asyncio(project_id: str, space_id: str, page_name: str, attachment_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 | PageAttachmentsSingleGetResponse | None¶

Returns the specified Page Attachment.

Args:: project_id (str): space_id (str): page_name (str): attachment_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 | PageAttachmentsSingleGetResponse

async polarion_rest_api_client.open_api_client.api.page_attachments.get_page_attachment.asyncio_detailed(project_id: str, space_id: str, page_name: str, attachment_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 | PageAttachmentsSingleGetResponse]¶

Returns the specified Page Attachment.

Args:: project_id (str): space_id (str): page_name (str): attachment_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 | PageAttachmentsSingleGetResponse]

polarion_rest_api_client.open_api_client.api.page_attachments.get_page_attachment.sync(project_id: str, space_id: str, page_name: str, attachment_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 | PageAttachmentsSingleGetResponse | None¶

Returns the specified Page Attachment.

Args:: project_id (str): space_id (str): page_name (str): attachment_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 | PageAttachmentsSingleGetResponse

polarion_rest_api_client.open_api_client.api.page_attachments.get_page_attachment.sync_detailed(project_id: str, space_id: str, page_name: str, attachment_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 | PageAttachmentsSingleGetResponse]¶

Returns the specified Page Attachment.

Args:: project_id (str): space_id (str): page_name (str): attachment_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 | PageAttachmentsSingleGetResponse]

polarion_rest_api_client.open_api_client.api.page_attachments.get_page_attachment_content module¶

async polarion_rest_api_client.open_api_client.api.page_attachments.get_page_attachment_content.asyncio(project_id: str, space_id: str, page_name: str, attachment_id: str, *, client: AuthenticatedClient | Client, revision: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>) → Any | Errors | None¶

Downloads the file content for a specified Page Attachment.

Args:: project_id (str): space_id (str): page_name (str): attachment_id (str): 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:: Any | Errors

async polarion_rest_api_client.open_api_client.api.page_attachments.get_page_attachment_content.asyncio_detailed(project_id: str, space_id: str, page_name: str, attachment_id: str, *, client: AuthenticatedClient | Client, revision: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>) → Response[Any | Errors]¶

Downloads the file content for a specified Page Attachment.

Args:: project_id (str): space_id (str): page_name (str): attachment_id (str): 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[Any | Errors]

polarion_rest_api_client.open_api_client.api.page_attachments.get_page_attachment_content.sync(project_id: str, space_id: str, page_name: str, attachment_id: str, *, client: AuthenticatedClient | Client, revision: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>) → Any | Errors | None¶

Downloads the file content for a specified Page Attachment.

Args:: project_id (str): space_id (str): page_name (str): attachment_id (str): 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:: Any | Errors

polarion_rest_api_client.open_api_client.api.page_attachments.get_page_attachment_content.sync_detailed(project_id: str, space_id: str, page_name: str, attachment_id: str, *, client: AuthenticatedClient | Client, revision: str | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>) → Response[Any | Errors]¶

Downloads the file content for a specified Page Attachment.

Args:: project_id (str): space_id (str): page_name (str): attachment_id (str): 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[Any | Errors]

polarion_rest_api_client.open_api_client.api.page_attachments.get_page_attachments module¶

async polarion_rest_api_client.open_api_client.api.page_attachments.get_page_attachments.asyncio(project_id: str, space_id: str, page_name: 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 | PageAttachmentsListGetResponse | None¶

Returns a list of Page Attachments.

Args:: project_id (str): space_id (str): page_name (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 | PageAttachmentsListGetResponse

async polarion_rest_api_client.open_api_client.api.page_attachments.get_page_attachments.asyncio_detailed(project_id: str, space_id: str, page_name: 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 | PageAttachmentsListGetResponse]¶

Returns a list of Page Attachments.

Args:: project_id (str): space_id (str): page_name (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 | PageAttachmentsListGetResponse]

polarion_rest_api_client.open_api_client.api.page_attachments.get_page_attachments.sync(project_id: str, space_id: str, page_name: 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 | PageAttachmentsListGetResponse | None¶

Returns a list of Page Attachments.

Args:: project_id (str): space_id (str): page_name (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 | PageAttachmentsListGetResponse

polarion_rest_api_client.open_api_client.api.page_attachments.get_page_attachments.sync_detailed(project_id: str, space_id: str, page_name: 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 | PageAttachmentsListGetResponse]¶

Returns a list of Page Attachments.

Args:: project_id (str): space_id (str): page_name (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 | PageAttachmentsListGetResponse]

polarion_rest_api_client.open_api_client.api.page_attachments.patch_page_attachment module¶

async polarion_rest_api_client.open_api_client.api.page_attachments.patch_page_attachment.asyncio(project_id: str, space_id: str, page_name: str, attachment_id: str, *, client: AuthenticatedClient | Client, body: PatchPageAttachmentsRequestBody | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>) → Any | Errors | None¶

Updates the specified Page Attachment.

See more in the <a href="https://docs.sw.siemens.com/en-

US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871" target="_blank">REST API User Guide</a>.

Args:: project_id (str): space_id (str): page_name (str): attachment_id (str): body (PatchPageAttachmentsRequestBody | 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:: Any | Errors

async polarion_rest_api_client.open_api_client.api.page_attachments.patch_page_attachment.asyncio_detailed(project_id: str, space_id: str, page_name: str, attachment_id: str, *, client: AuthenticatedClient | Client, body: PatchPageAttachmentsRequestBody | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>) → Response[Any | Errors]¶

Updates the specified Page Attachment.

See more in the <a href="https://docs.sw.siemens.com/en-

US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871" target="_blank">REST API User Guide</a>.

Args:: project_id (str): space_id (str): page_name (str): attachment_id (str): body (PatchPageAttachmentsRequestBody | 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[Any | Errors]

polarion_rest_api_client.open_api_client.api.page_attachments.patch_page_attachment.sync(project_id: str, space_id: str, page_name: str, attachment_id: str, *, client: AuthenticatedClient | Client, body: PatchPageAttachmentsRequestBody | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>) → Any | Errors | None¶

Updates the specified Page Attachment.

See more in the <a href="https://docs.sw.siemens.com/en-

US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871" target="_blank">REST API User Guide</a>.

Args:: project_id (str): space_id (str): page_name (str): attachment_id (str): body (PatchPageAttachmentsRequestBody | 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:: Any | Errors

polarion_rest_api_client.open_api_client.api.page_attachments.patch_page_attachment.sync_detailed(project_id: str, space_id: str, page_name: str, attachment_id: str, *, client: AuthenticatedClient | Client, body: PatchPageAttachmentsRequestBody | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>) → Response[Any | Errors]¶

Updates the specified Page Attachment.

See more in the <a href="https://docs.sw.siemens.com/en-

US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871" target="_blank">REST API User Guide</a>.

Args:: project_id (str): space_id (str): page_name (str): attachment_id (str): body (PatchPageAttachmentsRequestBody | 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[Any | Errors]

polarion_rest_api_client.open_api_client.api.page_attachments.post_page_attachments module¶

async polarion_rest_api_client.open_api_client.api.page_attachments.post_page_attachments.asyncio(project_id: str, space_id: str, page_name: str, *, client: AuthenticatedClient | Client, body: PostPageAttachmentsRequestBody) → Errors | PageAttachmentsListPostResponse | None¶

Creates a list of Page Attachments.

Files are identified by order or optionally by the ‘lid’ attribute. See more in the <a

href="https://docs.sw.siemens.com/en- US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871" target="_blank">REST API User Guide</a>.

Args:: project_id (str): space_id (str): page_name (str): body (PostPageAttachmentsRequestBody):
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 | PageAttachmentsListPostResponse

async polarion_rest_api_client.open_api_client.api.page_attachments.post_page_attachments.asyncio_detailed(project_id: str, space_id: str, page_name: str, *, client: AuthenticatedClient | Client, body: PostPageAttachmentsRequestBody) → Response[Errors | PageAttachmentsListPostResponse]¶

Creates a list of Page Attachments.

Files are identified by order or optionally by the ‘lid’ attribute. See more in the <a

href="https://docs.sw.siemens.com/en- US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871" target="_blank">REST API User Guide</a>.

Args:: project_id (str): space_id (str): page_name (str): body (PostPageAttachmentsRequestBody):
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 | PageAttachmentsListPostResponse]

polarion_rest_api_client.open_api_client.api.page_attachments.post_page_attachments.sync(project_id: str, space_id: str, page_name: str, *, client: AuthenticatedClient | Client, body: PostPageAttachmentsRequestBody) → Errors | PageAttachmentsListPostResponse | None¶

Creates a list of Page Attachments.

Files are identified by order or optionally by the ‘lid’ attribute. See more in the <a

href="https://docs.sw.siemens.com/en- US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871" target="_blank">REST API User Guide</a>.

Args:: project_id (str): space_id (str): page_name (str): body (PostPageAttachmentsRequestBody):
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 | PageAttachmentsListPostResponse

polarion_rest_api_client.open_api_client.api.page_attachments.post_page_attachments.sync_detailed(project_id: str, space_id: str, page_name: str, *, client: AuthenticatedClient | Client, body: PostPageAttachmentsRequestBody) → Response[Errors | PageAttachmentsListPostResponse]¶

Creates a list of Page Attachments.

Files are identified by order or optionally by the ‘lid’ attribute. See more in the <a

href="https://docs.sw.siemens.com/en- US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871" target="_blank">REST API User Guide</a>.

Args:: project_id (str): space_id (str): page_name (str): body (PostPageAttachmentsRequestBody):
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 | PageAttachmentsListPostResponse]