polarion_rest_api_client.open_api_client.api.document_attachments package¶

Contains endpoint functions for accessing the API.

Submodules¶

polarion_rest_api_client.open_api_client.api.document_attachments.get_document_attachment module¶

async polarion_rest_api_client.open_api_client.api.document_attachments.get_document_attachment.asyncio(project_id: str, space_id: str, document_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>) → DocumentAttachmentsSingleGetResponse | Errors | None¶

Returns the specified Document Attachment.

Args:: project_id (str): space_id (str): document_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[DocumentAttachmentsSingleGetResponse, Errors]

async polarion_rest_api_client.open_api_client.api.document_attachments.get_document_attachment.asyncio_detailed(project_id: str, space_id: str, document_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[DocumentAttachmentsSingleGetResponse | Errors]¶

Returns the specified Document Attachment.

Args:: project_id (str): space_id (str): document_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[DocumentAttachmentsSingleGetResponse, Errors]]

polarion_rest_api_client.open_api_client.api.document_attachments.get_document_attachment.sync(project_id: str, space_id: str, document_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>) → DocumentAttachmentsSingleGetResponse | Errors | None¶

Returns the specified Document Attachment.

Args:: project_id (str): space_id (str): document_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[DocumentAttachmentsSingleGetResponse, Errors]

polarion_rest_api_client.open_api_client.api.document_attachments.get_document_attachment.sync_detailed(project_id: str, space_id: str, document_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[DocumentAttachmentsSingleGetResponse | Errors]¶

Returns the specified Document Attachment.

Args:: project_id (str): space_id (str): document_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[DocumentAttachmentsSingleGetResponse, Errors]]

polarion_rest_api_client.open_api_client.api.document_attachments.get_document_attachment_content module¶

async polarion_rest_api_client.open_api_client.api.document_attachments.get_document_attachment_content.asyncio(project_id: str, space_id: str, document_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 Document Attachment.

Args:: project_id (str): space_id (str): document_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.document_attachments.get_document_attachment_content.asyncio_detailed(project_id: str, space_id: str, document_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 Document Attachment.

Args:: project_id (str): space_id (str): document_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.document_attachments.get_document_attachment_content.sync(project_id: str, space_id: str, document_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 Document Attachment.

Args:: project_id (str): space_id (str): document_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.document_attachments.get_document_attachment_content.sync_detailed(project_id: str, space_id: str, document_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 Document Attachment.

Args:: project_id (str): space_id (str): document_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.document_attachments.get_document_attachments module¶

async polarion_rest_api_client.open_api_client.api.document_attachments.get_document_attachments.asyncio(project_id: str, space_id: str, document_name: 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>) → DocumentAttachmentsListGetResponse | Errors | None¶

Returns a list of Document Attachments.

Args:: project_id (str): space_id (str): document_name (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[DocumentAttachmentsListGetResponse, Errors]

async polarion_rest_api_client.open_api_client.api.document_attachments.get_document_attachments.asyncio_detailed(project_id: str, space_id: str, document_name: 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[DocumentAttachmentsListGetResponse | Errors]¶

Returns a list of Document Attachments.

Args:: project_id (str): space_id (str): document_name (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[DocumentAttachmentsListGetResponse, Errors]]

polarion_rest_api_client.open_api_client.api.document_attachments.get_document_attachments.sync(project_id: str, space_id: str, document_name: 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>) → DocumentAttachmentsListGetResponse | Errors | None¶

Returns a list of Document Attachments.

Args:: project_id (str): space_id (str): document_name (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[DocumentAttachmentsListGetResponse, Errors]

polarion_rest_api_client.open_api_client.api.document_attachments.get_document_attachments.sync_detailed(project_id: str, space_id: str, document_name: 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[DocumentAttachmentsListGetResponse | Errors]¶

Returns a list of Document Attachments.

Args:: project_id (str): space_id (str): document_name (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[DocumentAttachmentsListGetResponse, Errors]]

polarion_rest_api_client.open_api_client.api.document_attachments.patch_document_attachment module¶

async polarion_rest_api_client.open_api_client.api.document_attachments.patch_document_attachment.asyncio(project_id: str, space_id: str, document_name: str, attachment_id: str, *, client: AuthenticatedClient | Client, body: PatchDocumentAttachmentsRequestBody) → Any | Errors | None¶

Updates the specified Document Attachment.

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): document_name (str): attachment_id (str): body (PatchDocumentAttachmentsRequestBody):
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.document_attachments.patch_document_attachment.asyncio_detailed(project_id: str, space_id: str, document_name: str, attachment_id: str, *, client: AuthenticatedClient | Client, body: PatchDocumentAttachmentsRequestBody) → Response[Any | Errors]¶

Updates the specified Document Attachment.

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): document_name (str): attachment_id (str): body (PatchDocumentAttachmentsRequestBody):
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.document_attachments.patch_document_attachment.sync(project_id: str, space_id: str, document_name: str, attachment_id: str, *, client: AuthenticatedClient | Client, body: PatchDocumentAttachmentsRequestBody) → Any | Errors | None¶

Updates the specified Document Attachment.

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): document_name (str): attachment_id (str): body (PatchDocumentAttachmentsRequestBody):
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.document_attachments.patch_document_attachment.sync_detailed(project_id: str, space_id: str, document_name: str, attachment_id: str, *, client: AuthenticatedClient | Client, body: PatchDocumentAttachmentsRequestBody) → Response[Any | Errors]¶

Updates the specified Document Attachment.

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): document_name (str): attachment_id (str): body (PatchDocumentAttachmentsRequestBody):
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.document_attachments.post_document_item_attachments module¶

async polarion_rest_api_client.open_api_client.api.document_attachments.post_document_item_attachments.asyncio(project_id: str, space_id: str, document_name: str, *, client: AuthenticatedClient | Client, body: PostDocumentAttachmentsRequestBody) → DocumentAttachmentsListPostResponse | Errors | None¶

Creates a list of Document 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): document_name (str): body (PostDocumentAttachmentsRequestBody):
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[DocumentAttachmentsListPostResponse, Errors]

async polarion_rest_api_client.open_api_client.api.document_attachments.post_document_item_attachments.asyncio_detailed(project_id: str, space_id: str, document_name: str, *, client: AuthenticatedClient | Client, body: PostDocumentAttachmentsRequestBody) → Response[DocumentAttachmentsListPostResponse | Errors]¶

Creates a list of Document 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): document_name (str): body (PostDocumentAttachmentsRequestBody):
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[DocumentAttachmentsListPostResponse, Errors]]

polarion_rest_api_client.open_api_client.api.document_attachments.post_document_item_attachments.sync(project_id: str, space_id: str, document_name: str, *, client: AuthenticatedClient | Client, body: PostDocumentAttachmentsRequestBody) → DocumentAttachmentsListPostResponse | Errors | None¶

Creates a list of Document 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): document_name (str): body (PostDocumentAttachmentsRequestBody):
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[DocumentAttachmentsListPostResponse, Errors]

polarion_rest_api_client.open_api_client.api.document_attachments.post_document_item_attachments.sync_detailed(project_id: str, space_id: str, document_name: str, *, client: AuthenticatedClient | Client, body: PostDocumentAttachmentsRequestBody) → Response[DocumentAttachmentsListPostResponse | Errors]¶

Creates a list of Document 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): document_name (str): body (PostDocumentAttachmentsRequestBody):
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[DocumentAttachmentsListPostResponse, Errors]]