polarion_rest_api_client.open_api_client.api.test_run_attachments package¶

Contains endpoint functions for accessing the API

Submodules¶

polarion_rest_api_client.open_api_client.api.test_run_attachments.delete_test_run_attachment module¶

async polarion_rest_api_client.open_api_client.api.test_run_attachments.delete_test_run_attachment.asyncio(project_id: str, test_run_id: str, attachment_id: str, *, client: AuthenticatedClient | Client) → Any | Errors | None¶

Deletes the specified Test Run Attachment.

Args:: project_id (str): test_run_id (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.test_run_attachments.delete_test_run_attachment.asyncio_detailed(project_id: str, test_run_id: str, attachment_id: str, *, client: AuthenticatedClient | Client) → Response[Any | Errors]¶

Deletes the specified Test Run Attachment.

Args:: project_id (str): test_run_id (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.test_run_attachments.delete_test_run_attachment.sync(project_id: str, test_run_id: str, attachment_id: str, *, client: AuthenticatedClient | Client) → Any | Errors | None¶

Deletes the specified Test Run Attachment.

Args:: project_id (str): test_run_id (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.test_run_attachments.delete_test_run_attachment.sync_detailed(project_id: str, test_run_id: str, attachment_id: str, *, client: AuthenticatedClient | Client) → Response[Any | Errors]¶

Deletes the specified Test Run Attachment.

Args:: project_id (str): test_run_id (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.test_run_attachments.delete_test_run_attachments module¶

async polarion_rest_api_client.open_api_client.api.test_run_attachments.delete_test_run_attachments.asyncio(project_id: str, test_run_id: str, *, client: AuthenticatedClient | Client, body: TestrunAttachmentsListDeleteRequest) → Any | Errors | None¶

Deletes a list of Test Run Attachments.

Args:: project_id (str): test_run_id (str): body (TestrunAttachmentsListDeleteRequest):
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.test_run_attachments.delete_test_run_attachments.asyncio_detailed(project_id: str, test_run_id: str, *, client: AuthenticatedClient | Client, body: TestrunAttachmentsListDeleteRequest) → Response[Any | Errors]¶

Deletes a list of Test Run Attachments.

Args:: project_id (str): test_run_id (str): body (TestrunAttachmentsListDeleteRequest):
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.test_run_attachments.delete_test_run_attachments.sync(project_id: str, test_run_id: str, *, client: AuthenticatedClient | Client, body: TestrunAttachmentsListDeleteRequest) → Any | Errors | None¶

Deletes a list of Test Run Attachments.

Args:: project_id (str): test_run_id (str): body (TestrunAttachmentsListDeleteRequest):
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.test_run_attachments.delete_test_run_attachments.sync_detailed(project_id: str, test_run_id: str, *, client: AuthenticatedClient | Client, body: TestrunAttachmentsListDeleteRequest) → Response[Any | Errors]¶

Deletes a list of Test Run Attachments.

Args:: project_id (str): test_run_id (str): body (TestrunAttachmentsListDeleteRequest):
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.test_run_attachments.get_test_run_attachment module¶

async polarion_rest_api_client.open_api_client.api.test_run_attachments.get_test_run_attachment.asyncio(project_id: str, test_run_id: 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 | TestrunAttachmentsSingleGetResponse | None¶

Returns the specified Test Run Attachment.

Args:: project_id (str): test_run_id (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 | TestrunAttachmentsSingleGetResponse

async polarion_rest_api_client.open_api_client.api.test_run_attachments.get_test_run_attachment.asyncio_detailed(project_id: str, test_run_id: 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 | TestrunAttachmentsSingleGetResponse]¶

Returns the specified Test Run Attachment.

Args:: project_id (str): test_run_id (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 | TestrunAttachmentsSingleGetResponse]

polarion_rest_api_client.open_api_client.api.test_run_attachments.get_test_run_attachment.sync(project_id: str, test_run_id: 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 | TestrunAttachmentsSingleGetResponse | None¶

Returns the specified Test Run Attachment.

Args:: project_id (str): test_run_id (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 | TestrunAttachmentsSingleGetResponse

polarion_rest_api_client.open_api_client.api.test_run_attachments.get_test_run_attachment.sync_detailed(project_id: str, test_run_id: 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 | TestrunAttachmentsSingleGetResponse]¶

Returns the specified Test Run Attachment.

Args:: project_id (str): test_run_id (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 | TestrunAttachmentsSingleGetResponse]

polarion_rest_api_client.open_api_client.api.test_run_attachments.get_test_run_attachment_content module¶

async polarion_rest_api_client.open_api_client.api.test_run_attachments.get_test_run_attachment_content.asyncio(project_id: str, test_run_id: 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 Test Run Attachment.

Args:: project_id (str): test_run_id (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.test_run_attachments.get_test_run_attachment_content.asyncio_detailed(project_id: str, test_run_id: 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 Test Run Attachment.

Args:: project_id (str): test_run_id (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.test_run_attachments.get_test_run_attachment_content.sync(project_id: str, test_run_id: 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 Test Run Attachment.

Args:: project_id (str): test_run_id (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.test_run_attachments.get_test_run_attachment_content.sync_detailed(project_id: str, test_run_id: 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 Test Run Attachment.

Args:: project_id (str): test_run_id (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.test_run_attachments.get_test_run_attachments module¶

async polarion_rest_api_client.open_api_client.api.test_run_attachments.get_test_run_attachments.asyncio(project_id: str, test_run_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 | TestrunAttachmentsListGetResponse | None¶

Returns a list of Test Run Attachments.

Args:: project_id (str): test_run_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 | TestrunAttachmentsListGetResponse

async polarion_rest_api_client.open_api_client.api.test_run_attachments.get_test_run_attachments.asyncio_detailed(project_id: str, test_run_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 | TestrunAttachmentsListGetResponse]¶

Returns a list of Test Run Attachments.

Args:: project_id (str): test_run_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 | TestrunAttachmentsListGetResponse]

polarion_rest_api_client.open_api_client.api.test_run_attachments.get_test_run_attachments.sync(project_id: str, test_run_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 | TestrunAttachmentsListGetResponse | None¶

Returns a list of Test Run Attachments.

Args:: project_id (str): test_run_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 | TestrunAttachmentsListGetResponse

polarion_rest_api_client.open_api_client.api.test_run_attachments.get_test_run_attachments.sync_detailed(project_id: str, test_run_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 | TestrunAttachmentsListGetResponse]¶

Returns a list of Test Run Attachments.

Args:: project_id (str): test_run_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 | TestrunAttachmentsListGetResponse]

polarion_rest_api_client.open_api_client.api.test_run_attachments.patch_test_run_attachment module¶

async polarion_rest_api_client.open_api_client.api.test_run_attachments.patch_test_run_attachment.asyncio(project_id: str, test_run_id: str, attachment_id: str, *, client: AuthenticatedClient | Client, body: PatchTestRunAttachmentsRequestBody | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>) → Any | Errors | None¶

Updates the specified Test Run 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): test_run_id (str): attachment_id (str): body (PatchTestRunAttachmentsRequestBody | 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.test_run_attachments.patch_test_run_attachment.asyncio_detailed(project_id: str, test_run_id: str, attachment_id: str, *, client: AuthenticatedClient | Client, body: PatchTestRunAttachmentsRequestBody | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>) → Response[Any | Errors]¶

Updates the specified Test Run 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): test_run_id (str): attachment_id (str): body (PatchTestRunAttachmentsRequestBody | 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.test_run_attachments.patch_test_run_attachment.sync(project_id: str, test_run_id: str, attachment_id: str, *, client: AuthenticatedClient | Client, body: PatchTestRunAttachmentsRequestBody | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>) → Any | Errors | None¶

Updates the specified Test Run 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): test_run_id (str): attachment_id (str): body (PatchTestRunAttachmentsRequestBody | 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.test_run_attachments.patch_test_run_attachment.sync_detailed(project_id: str, test_run_id: str, attachment_id: str, *, client: AuthenticatedClient | Client, body: PatchTestRunAttachmentsRequestBody | Unset = <polarion_rest_api_client.open_api_client.types.Unset object>) → Response[Any | Errors]¶

Updates the specified Test Run 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): test_run_id (str): attachment_id (str): body (PatchTestRunAttachmentsRequestBody | 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.test_run_attachments.post_test_run_attachments module¶

async polarion_rest_api_client.open_api_client.api.test_run_attachments.post_test_run_attachments.asyncio(project_id: str, test_run_id: str, *, client: AuthenticatedClient | Client, body: PostTestRunAttachmentsRequestBody) → Errors | TestrunAttachmentsListPostResponse | None¶

Creates a list of Test Run 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): test_run_id (str): body (PostTestRunAttachmentsRequestBody):
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 | TestrunAttachmentsListPostResponse

async polarion_rest_api_client.open_api_client.api.test_run_attachments.post_test_run_attachments.asyncio_detailed(project_id: str, test_run_id: str, *, client: AuthenticatedClient | Client, body: PostTestRunAttachmentsRequestBody) → Response[Errors | TestrunAttachmentsListPostResponse]¶

Creates a list of Test Run 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): test_run_id (str): body (PostTestRunAttachmentsRequestBody):
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 | TestrunAttachmentsListPostResponse]

polarion_rest_api_client.open_api_client.api.test_run_attachments.post_test_run_attachments.sync(project_id: str, test_run_id: str, *, client: AuthenticatedClient | Client, body: PostTestRunAttachmentsRequestBody) → Errors | TestrunAttachmentsListPostResponse | None¶

Creates a list of Test Run 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): test_run_id (str): body (PostTestRunAttachmentsRequestBody):
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 | TestrunAttachmentsListPostResponse

polarion_rest_api_client.open_api_client.api.test_run_attachments.post_test_run_attachments.sync_detailed(project_id: str, test_run_id: str, *, client: AuthenticatedClient | Client, body: PostTestRunAttachmentsRequestBody) → Response[Errors | TestrunAttachmentsListPostResponse]¶

Creates a list of Test Run 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): test_run_id (str): body (PostTestRunAttachmentsRequestBody):
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 | TestrunAttachmentsListPostResponse]