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.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: ~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 | PageAttachmentsSingleGetResponse | None¶

Returns the specified Page Attachment.

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

Returns the specified Page Attachment.

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

Returns the specified Page Attachment.

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

Returns the specified Page Attachment.

Args:: project_id (str): space_id (str): page_name (str): attachment_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, 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: ~polarion_rest_api_client.open_api_client.client.AuthenticatedClient | ~polarion_rest_api_client.open_api_client.client.Client, revision: ~polarion_rest_api_client.open_api_client.types.Unset | str = <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 (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[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: ~polarion_rest_api_client.open_api_client.client.AuthenticatedClient | ~polarion_rest_api_client.open_api_client.client.Client, revision: ~polarion_rest_api_client.open_api_client.types.Unset | str = <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 (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[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: ~polarion_rest_api_client.open_api_client.client.AuthenticatedClient | ~polarion_rest_api_client.open_api_client.client.Client, revision: ~polarion_rest_api_client.open_api_client.types.Unset | str = <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 (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[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: ~polarion_rest_api_client.open_api_client.client.AuthenticatedClient | ~polarion_rest_api_client.open_api_client.client.Client, revision: ~polarion_rest_api_client.open_api_client.types.Unset | str = <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 (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[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/PL20241023686685479.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:: Union[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/PL20241023686685479.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[Union[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/PL20241023686685479.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:: Union[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/PL20241023686685479.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[Union[Errors, PageAttachmentsListPostResponse]]