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:

Union[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[Union[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:

Union[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[Union[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:

Union[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[Union[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:

Union[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[Union[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: ~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 | TeststepsSingleGetResponse | None

Returns the specified Test Step.

Args:

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

Returns the specified Test Step.

Args:

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

Returns the specified Test Step.

Args:

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

Returns the specified Test Step.

Args:

project_id (str): work_item_id (str): test_step_index (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, 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: ~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>) → Errors | TeststepsListGetResponse | None

Returns a list of Test Steps.

Args:

project_id (str): work_item_id (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[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: ~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[Errors | TeststepsListGetResponse]

Returns a list of Test Steps.

Args:

project_id (str): work_item_id (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[Errors, TeststepsListGetResponse]]

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

Returns a list of Test Steps.

Args:

project_id (str): work_item_id (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[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: ~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[Errors | TeststepsListGetResponse]

Returns a list of Test Steps.

Args:

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

Union[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[Union[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:

Union[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[Union[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:

Union[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[Union[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:

Union[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[Union[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:

Union[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[Union[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:

Union[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[Union[Errors, TeststepsListPostResponse]]