polarion_rest_api_client.open_api_client.api.test_step_results package

Contains endpoint functions for accessing the API.

Submodules

polarion_rest_api_client.open_api_client.api.test_step_results.get_test_step_result module

async polarion_rest_api_client.open_api_client.api.test_step_results.get_test_step_result.asyncio(project_id: str, test_run_id: str, test_case_project_id: str, test_case_id: str, iteration: 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 | TeststepResultsSingleGetResponse | None

Returns the specified Test Step Result.

Args:

project_id (str): test_run_id (str): test_case_project_id (str): test_case_id (str): iteration (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, TeststepResultsSingleGetResponse]

async polarion_rest_api_client.open_api_client.api.test_step_results.get_test_step_result.asyncio_detailed(project_id: str, test_run_id: str, test_case_project_id: str, test_case_id: str, iteration: 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 | TeststepResultsSingleGetResponse]

Returns the specified Test Step Result.

Args:

project_id (str): test_run_id (str): test_case_project_id (str): test_case_id (str): iteration (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, TeststepResultsSingleGetResponse]]

polarion_rest_api_client.open_api_client.api.test_step_results.get_test_step_result.sync(project_id: str, test_run_id: str, test_case_project_id: str, test_case_id: str, iteration: 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 | TeststepResultsSingleGetResponse | None

Returns the specified Test Step Result.

Args:

project_id (str): test_run_id (str): test_case_project_id (str): test_case_id (str): iteration (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, TeststepResultsSingleGetResponse]

polarion_rest_api_client.open_api_client.api.test_step_results.get_test_step_result.sync_detailed(project_id: str, test_run_id: str, test_case_project_id: str, test_case_id: str, iteration: 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 | TeststepResultsSingleGetResponse]

Returns the specified Test Step Result.

Args:

project_id (str): test_run_id (str): test_case_project_id (str): test_case_id (str): iteration (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, TeststepResultsSingleGetResponse]]

polarion_rest_api_client.open_api_client.api.test_step_results.get_test_step_results module

async polarion_rest_api_client.open_api_client.api.test_step_results.get_test_step_results.asyncio(project_id: str, test_run_id: str, test_case_project_id: str, test_case_id: str, iteration: 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 | TeststepResultsListGetResponse | None

Returns a list of Test Step Results.

Args:

project_id (str): test_run_id (str): test_case_project_id (str): test_case_id (str): iteration (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, TeststepResultsListGetResponse]

async polarion_rest_api_client.open_api_client.api.test_step_results.get_test_step_results.asyncio_detailed(project_id: str, test_run_id: str, test_case_project_id: str, test_case_id: str, iteration: 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 | TeststepResultsListGetResponse]

Returns a list of Test Step Results.

Args:

project_id (str): test_run_id (str): test_case_project_id (str): test_case_id (str): iteration (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, TeststepResultsListGetResponse]]

polarion_rest_api_client.open_api_client.api.test_step_results.get_test_step_results.sync(project_id: str, test_run_id: str, test_case_project_id: str, test_case_id: str, iteration: 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 | TeststepResultsListGetResponse | None

Returns a list of Test Step Results.

Args:

project_id (str): test_run_id (str): test_case_project_id (str): test_case_id (str): iteration (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, TeststepResultsListGetResponse]

polarion_rest_api_client.open_api_client.api.test_step_results.get_test_step_results.sync_detailed(project_id: str, test_run_id: str, test_case_project_id: str, test_case_id: str, iteration: 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 | TeststepResultsListGetResponse]

Returns a list of Test Step Results.

Args:

project_id (str): test_run_id (str): test_case_project_id (str): test_case_id (str): iteration (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, TeststepResultsListGetResponse]]

polarion_rest_api_client.open_api_client.api.test_step_results.patch_test_step_result module

async polarion_rest_api_client.open_api_client.api.test_step_results.patch_test_step_result.asyncio(project_id: str, test_run_id: str, test_case_project_id: str, test_case_id: str, iteration: str, test_step_index: str, *, client: AuthenticatedClient | Client, body: TeststepResultsSinglePatchRequest) → Any | Errors | None

Updates the specified Test Step Result.

Args:

project_id (str): test_run_id (str): test_case_project_id (str): test_case_id (str): iteration (str): test_step_index (str): body (TeststepResultsSinglePatchRequest):

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_step_results.patch_test_step_result.asyncio_detailed(project_id: str, test_run_id: str, test_case_project_id: str, test_case_id: str, iteration: str, test_step_index: str, *, client: AuthenticatedClient | Client, body: TeststepResultsSinglePatchRequest) → Response[Any | Errors]

Updates the specified Test Step Result.

Args:

project_id (str): test_run_id (str): test_case_project_id (str): test_case_id (str): iteration (str): test_step_index (str): body (TeststepResultsSinglePatchRequest):

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_step_results.patch_test_step_result.sync(project_id: str, test_run_id: str, test_case_project_id: str, test_case_id: str, iteration: str, test_step_index: str, *, client: AuthenticatedClient | Client, body: TeststepResultsSinglePatchRequest) → Any | Errors | None

Updates the specified Test Step Result.

Args:

project_id (str): test_run_id (str): test_case_project_id (str): test_case_id (str): iteration (str): test_step_index (str): body (TeststepResultsSinglePatchRequest):

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_step_results.patch_test_step_result.sync_detailed(project_id: str, test_run_id: str, test_case_project_id: str, test_case_id: str, iteration: str, test_step_index: str, *, client: AuthenticatedClient | Client, body: TeststepResultsSinglePatchRequest) → Response[Any | Errors]

Updates the specified Test Step Result.

Args:

project_id (str): test_run_id (str): test_case_project_id (str): test_case_id (str): iteration (str): test_step_index (str): body (TeststepResultsSinglePatchRequest):

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_step_results.patch_test_step_results module

async polarion_rest_api_client.open_api_client.api.test_step_results.patch_test_step_results.asyncio(project_id: str, test_run_id: str, test_case_project_id: str, test_case_id: str, iteration: str, *, client: AuthenticatedClient | Client, body: TeststepResultsListPatchRequest) → Any | Errors | None

Updates a list of Test Step Results.

Args:

project_id (str): test_run_id (str): test_case_project_id (str): test_case_id (str): iteration (str): body (TeststepResultsListPatchRequest):

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_step_results.patch_test_step_results.asyncio_detailed(project_id: str, test_run_id: str, test_case_project_id: str, test_case_id: str, iteration: str, *, client: AuthenticatedClient | Client, body: TeststepResultsListPatchRequest) → Response[Any | Errors]

Updates a list of Test Step Results.

Args:

project_id (str): test_run_id (str): test_case_project_id (str): test_case_id (str): iteration (str): body (TeststepResultsListPatchRequest):

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_step_results.patch_test_step_results.sync(project_id: str, test_run_id: str, test_case_project_id: str, test_case_id: str, iteration: str, *, client: AuthenticatedClient | Client, body: TeststepResultsListPatchRequest) → Any | Errors | None

Updates a list of Test Step Results.

Args:

project_id (str): test_run_id (str): test_case_project_id (str): test_case_id (str): iteration (str): body (TeststepResultsListPatchRequest):

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_step_results.patch_test_step_results.sync_detailed(project_id: str, test_run_id: str, test_case_project_id: str, test_case_id: str, iteration: str, *, client: AuthenticatedClient | Client, body: TeststepResultsListPatchRequest) → Response[Any | Errors]

Updates a list of Test Step Results.

Args:

project_id (str): test_run_id (str): test_case_project_id (str): test_case_id (str): iteration (str): body (TeststepResultsListPatchRequest):

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_step_results.post_test_step_results module

async polarion_rest_api_client.open_api_client.api.test_step_results.post_test_step_results.asyncio(project_id: str, test_run_id: str, test_case_project_id: str, test_case_id: str, iteration: str, *, client: AuthenticatedClient | Client, body: TeststepResultsListPostRequest) → Errors | TeststepResultsListPostResponse | None

Creates a list of Test Step Results.

Args:

project_id (str): test_run_id (str): test_case_project_id (str): test_case_id (str): iteration (str): body (TeststepResultsListPostRequest):

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, TeststepResultsListPostResponse]

async polarion_rest_api_client.open_api_client.api.test_step_results.post_test_step_results.asyncio_detailed(project_id: str, test_run_id: str, test_case_project_id: str, test_case_id: str, iteration: str, *, client: AuthenticatedClient | Client, body: TeststepResultsListPostRequest) → Response[Errors | TeststepResultsListPostResponse]

Creates a list of Test Step Results.

Args:

project_id (str): test_run_id (str): test_case_project_id (str): test_case_id (str): iteration (str): body (TeststepResultsListPostRequest):

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, TeststepResultsListPostResponse]]

polarion_rest_api_client.open_api_client.api.test_step_results.post_test_step_results.sync(project_id: str, test_run_id: str, test_case_project_id: str, test_case_id: str, iteration: str, *, client: AuthenticatedClient | Client, body: TeststepResultsListPostRequest) → Errors | TeststepResultsListPostResponse | None

Creates a list of Test Step Results.

Args:

project_id (str): test_run_id (str): test_case_project_id (str): test_case_id (str): iteration (str): body (TeststepResultsListPostRequest):

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, TeststepResultsListPostResponse]

polarion_rest_api_client.open_api_client.api.test_step_results.post_test_step_results.sync_detailed(project_id: str, test_run_id: str, test_case_project_id: str, test_case_id: str, iteration: str, *, client: AuthenticatedClient | Client, body: TeststepResultsListPostRequest) → Response[Errors | TeststepResultsListPostResponse]

Creates a list of Test Step Results.

Args:

project_id (str): test_run_id (str): test_case_project_id (str): test_case_id (str): iteration (str): body (TeststepResultsListPostRequest):

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, TeststepResultsListPostResponse]]