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: 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 | 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 (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 | 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: 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 | 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 (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 | 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: 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 | 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 (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 | 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: 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 | 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 (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 | 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: 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 | 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 (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 | 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: 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 | 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 (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 | 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: 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 | 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 (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 | 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: 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 | 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 (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 | 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:

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

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

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

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

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

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[Errors | TeststepResultsListPostResponse]