polarion_rest_api_client.open_api_client.api.test_steps package

Contains endpoint functions for accessing the API

Submodules

polarion_rest_api_client.open_api_client.api.test_steps.delete_test_step module

async polarion_rest_api_client.open_api_client.api.test_steps.delete_test_step.asyncio(project_id: str, work_item_id: str, test_step_index: str, *, client: AuthenticatedClient | Client) → Any | Errors | None

Deletes the specified Test Step.

Args:

project_id (str): work_item_id (str): test_step_index (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_steps.delete_test_step.asyncio_detailed(project_id: str, work_item_id: str, test_step_index: str, *, client: AuthenticatedClient | Client) → Response[Any | Errors]

Deletes the specified Test Step.

Args:

project_id (str): work_item_id (str): test_step_index (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_steps.delete_test_step.sync(project_id: str, work_item_id: str, test_step_index: str, *, client: AuthenticatedClient | Client) → Any | Errors | None

Deletes the specified Test Step.

Args:

project_id (str): work_item_id (str): test_step_index (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_steps.delete_test_step.sync_detailed(project_id: str, work_item_id: str, test_step_index: str, *, client: AuthenticatedClient | Client) → Response[Any | Errors]

Deletes the specified Test Step.

Args:

project_id (str): work_item_id (str): test_step_index (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_steps.delete_test_steps module

async polarion_rest_api_client.open_api_client.api.test_steps.delete_test_steps.asyncio(project_id: str, work_item_id: str, *, client: AuthenticatedClient | Client, body: TeststepsListDeleteRequest) → Any | Errors | None

Deletes a list of Test Steps.

Args:

project_id (str): work_item_id (str): body (TeststepsListDeleteRequest):

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

Deletes a list of Test Steps.

Args:

project_id (str): work_item_id (str): body (TeststepsListDeleteRequest):

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_steps.delete_test_steps.sync(project_id: str, work_item_id: str, *, client: AuthenticatedClient | Client, body: TeststepsListDeleteRequest) → Any | Errors | None

Deletes a list of Test Steps.

Args:

project_id (str): work_item_id (str): body (TeststepsListDeleteRequest):

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

Deletes a list of Test Steps.

Args:

project_id (str): work_item_id (str): body (TeststepsListDeleteRequest):

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_steps.get_test_step module

async polarion_rest_api_client.open_api_client.api.test_steps.get_test_step.asyncio(project_id: str, work_item_id: str, test_step_index: 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 | TeststepsSingleGetResponse | None

Returns the specified Test Step.

Args:

project_id (str): work_item_id (str): test_step_index (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 | TeststepsSingleGetResponse

async polarion_rest_api_client.open_api_client.api.test_steps.get_test_step.asyncio_detailed(project_id: str, work_item_id: str, test_step_index: 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 | TeststepsSingleGetResponse]

Returns the specified Test Step.

Args:

project_id (str): work_item_id (str): test_step_index (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 | TeststepsSingleGetResponse]

polarion_rest_api_client.open_api_client.api.test_steps.get_test_step.sync(project_id: str, work_item_id: str, test_step_index: 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 | TeststepsSingleGetResponse | None

Returns the specified Test Step.

Args:

project_id (str): work_item_id (str): test_step_index (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 | TeststepsSingleGetResponse

polarion_rest_api_client.open_api_client.api.test_steps.get_test_step.sync_detailed(project_id: str, work_item_id: str, test_step_index: 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 | TeststepsSingleGetResponse]

Returns the specified Test Step.

Args:

project_id (str): work_item_id (str): test_step_index (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 | TeststepsSingleGetResponse]

polarion_rest_api_client.open_api_client.api.test_steps.get_test_steps module

async polarion_rest_api_client.open_api_client.api.test_steps.get_test_steps.asyncio(project_id: str, work_item_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 | TeststepsListGetResponse | None

Returns a list of Test Steps.

Args:

project_id (str): work_item_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 | TeststepsListGetResponse

async polarion_rest_api_client.open_api_client.api.test_steps.get_test_steps.asyncio_detailed(project_id: str, work_item_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 | TeststepsListGetResponse]

Returns a list of Test Steps.

Args:

project_id (str): work_item_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 | TeststepsListGetResponse]

polarion_rest_api_client.open_api_client.api.test_steps.get_test_steps.sync(project_id: str, work_item_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 | TeststepsListGetResponse | None

Returns a list of Test Steps.

Args:

project_id (str): work_item_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 | TeststepsListGetResponse

polarion_rest_api_client.open_api_client.api.test_steps.get_test_steps.sync_detailed(project_id: str, work_item_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 | TeststepsListGetResponse]

Returns a list of Test Steps.

Args:

project_id (str): work_item_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 | TeststepsListGetResponse]

polarion_rest_api_client.open_api_client.api.test_steps.patch_test_step module

async polarion_rest_api_client.open_api_client.api.test_steps.patch_test_step.asyncio(project_id: str, work_item_id: str, test_step_index: str, *, client: AuthenticatedClient | Client, body: TeststepsSinglePatchRequest) → Any | Errors | None

Updates the specified Test Step.

Args:

project_id (str): work_item_id (str): test_step_index (str): body (TeststepsSinglePatchRequest):

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_steps.patch_test_step.asyncio_detailed(project_id: str, work_item_id: str, test_step_index: str, *, client: AuthenticatedClient | Client, body: TeststepsSinglePatchRequest) → Response[Any | Errors]

Updates the specified Test Step.

Args:

project_id (str): work_item_id (str): test_step_index (str): body (TeststepsSinglePatchRequest):

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_steps.patch_test_step.sync(project_id: str, work_item_id: str, test_step_index: str, *, client: AuthenticatedClient | Client, body: TeststepsSinglePatchRequest) → Any | Errors | None

Updates the specified Test Step.

Args:

project_id (str): work_item_id (str): test_step_index (str): body (TeststepsSinglePatchRequest):

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_steps.patch_test_step.sync_detailed(project_id: str, work_item_id: str, test_step_index: str, *, client: AuthenticatedClient | Client, body: TeststepsSinglePatchRequest) → Response[Any | Errors]

Updates the specified Test Step.

Args:

project_id (str): work_item_id (str): test_step_index (str): body (TeststepsSinglePatchRequest):

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_steps.patch_test_steps module

async polarion_rest_api_client.open_api_client.api.test_steps.patch_test_steps.asyncio(project_id: str, work_item_id: str, *, client: AuthenticatedClient | Client, body: TeststepsListPatchRequest) → Any | Errors | None

Updates a list of Test Steps.

Args:

project_id (str): work_item_id (str): body (TeststepsListPatchRequest):

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

Updates a list of Test Steps.

Args:

project_id (str): work_item_id (str): body (TeststepsListPatchRequest):

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_steps.patch_test_steps.sync(project_id: str, work_item_id: str, *, client: AuthenticatedClient | Client, body: TeststepsListPatchRequest) → Any | Errors | None

Updates a list of Test Steps.

Args:

project_id (str): work_item_id (str): body (TeststepsListPatchRequest):

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

Updates a list of Test Steps.

Args:

project_id (str): work_item_id (str): body (TeststepsListPatchRequest):

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_steps.post_test_steps module

async polarion_rest_api_client.open_api_client.api.test_steps.post_test_steps.asyncio(project_id: str, work_item_id: str, *, client: AuthenticatedClient | Client, body: TeststepsListPostRequest) → Errors | TeststepsListPostResponse | None

Creates a list of Test Steps.

Args:

project_id (str): work_item_id (str): body (TeststepsListPostRequest):

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 | TeststepsListPostResponse

async polarion_rest_api_client.open_api_client.api.test_steps.post_test_steps.asyncio_detailed(project_id: str, work_item_id: str, *, client: AuthenticatedClient | Client, body: TeststepsListPostRequest) → Response[Errors | TeststepsListPostResponse]

Creates a list of Test Steps.

Args:

project_id (str): work_item_id (str): body (TeststepsListPostRequest):

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 | TeststepsListPostResponse]

polarion_rest_api_client.open_api_client.api.test_steps.post_test_steps.sync(project_id: str, work_item_id: str, *, client: AuthenticatedClient | Client, body: TeststepsListPostRequest) → Errors | TeststepsListPostResponse | None

Creates a list of Test Steps.

Args:

project_id (str): work_item_id (str): body (TeststepsListPostRequest):

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 | TeststepsListPostResponse

polarion_rest_api_client.open_api_client.api.test_steps.post_test_steps.sync_detailed(project_id: str, work_item_id: str, *, client: AuthenticatedClient | Client, body: TeststepsListPostRequest) → Response[Errors | TeststepsListPostResponse]

Creates a list of Test Steps.

Args:

project_id (str): work_item_id (str): body (TeststepsListPostRequest):

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 | TeststepsListPostResponse]