polarion_rest_api_client.open_api_client.api.projects package¶

Contains endpoint functions for accessing the API.

Submodules¶

polarion_rest_api_client.open_api_client.api.projects.create_project module¶

async polarion_rest_api_client.open_api_client.api.projects.create_project.asyncio(*, client: AuthenticatedClient | Client, body: CreateProjectRequestBody) → Errors | JobsSinglePostResponse | None¶

Creates a new Project.

Args:: body (CreateProjectRequestBody):
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, JobsSinglePostResponse]

async polarion_rest_api_client.open_api_client.api.projects.create_project.asyncio_detailed(*, client: AuthenticatedClient | Client, body: CreateProjectRequestBody) → Response[Errors | JobsSinglePostResponse]¶

Creates a new Project.

Args:: body (CreateProjectRequestBody):
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, JobsSinglePostResponse]]

polarion_rest_api_client.open_api_client.api.projects.create_project.sync(*, client: AuthenticatedClient | Client, body: CreateProjectRequestBody) → Errors | JobsSinglePostResponse | None¶

Creates a new Project.

Args:: body (CreateProjectRequestBody):
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, JobsSinglePostResponse]

polarion_rest_api_client.open_api_client.api.projects.create_project.sync_detailed(*, client: AuthenticatedClient | Client, body: CreateProjectRequestBody) → Response[Errors | JobsSinglePostResponse]¶

Creates a new Project.

Args:: body (CreateProjectRequestBody):
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, JobsSinglePostResponse]]

polarion_rest_api_client.open_api_client.api.projects.delete_project module¶

async polarion_rest_api_client.open_api_client.api.projects.delete_project.asyncio(project_id: str, *, client: AuthenticatedClient | Client) → Errors | JobsSinglePostResponse | None¶

Deletes the specified Project.

Args:: project_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:: Union[Errors, JobsSinglePostResponse]

async polarion_rest_api_client.open_api_client.api.projects.delete_project.asyncio_detailed(project_id: str, *, client: AuthenticatedClient | Client) → Response[Errors | JobsSinglePostResponse]¶

Deletes the specified Project.

Args:: project_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[Union[Errors, JobsSinglePostResponse]]

polarion_rest_api_client.open_api_client.api.projects.delete_project.sync(project_id: str, *, client: AuthenticatedClient | Client) → Errors | JobsSinglePostResponse | None¶

Deletes the specified Project.

Args:: project_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:: Union[Errors, JobsSinglePostResponse]

polarion_rest_api_client.open_api_client.api.projects.delete_project.sync_detailed(project_id: str, *, client: AuthenticatedClient | Client) → Response[Errors | JobsSinglePostResponse]¶

Deletes the specified Project.

Args:: project_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[Union[Errors, JobsSinglePostResponse]]

polarion_rest_api_client.open_api_client.api.projects.delete_project_test_parameter_definition module¶

async polarion_rest_api_client.open_api_client.api.projects.delete_project_test_parameter_definition.asyncio(project_id: str, test_param_id: str, *, client: AuthenticatedClient | Client) → Any | Errors | None¶

Deletes the specified Test Parameter Definition for the specified Project.

Args:: project_id (str): test_param_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:: Union[Any, Errors]

async polarion_rest_api_client.open_api_client.api.projects.delete_project_test_parameter_definition.asyncio_detailed(project_id: str, test_param_id: str, *, client: AuthenticatedClient | Client) → Response[Any | Errors]¶

Deletes the specified Test Parameter Definition for the specified Project.

Args:: project_id (str): test_param_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[Union[Any, Errors]]

polarion_rest_api_client.open_api_client.api.projects.delete_project_test_parameter_definition.sync(project_id: str, test_param_id: str, *, client: AuthenticatedClient | Client) → Any | Errors | None¶

Deletes the specified Test Parameter Definition for the specified Project.

Args:: project_id (str): test_param_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:: Union[Any, Errors]

polarion_rest_api_client.open_api_client.api.projects.delete_project_test_parameter_definition.sync_detailed(project_id: str, test_param_id: str, *, client: AuthenticatedClient | Client) → Response[Any | Errors]¶

Deletes the specified Test Parameter Definition for the specified Project.

Args:: project_id (str): test_param_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[Union[Any, Errors]]

polarion_rest_api_client.open_api_client.api.projects.delete_project_test_parameter_definitions module¶

async polarion_rest_api_client.open_api_client.api.projects.delete_project_test_parameter_definitions.asyncio(project_id: str, *, client: AuthenticatedClient | Client, body: TestparameterDefinitionsListDeleteRequest) → Any | Errors | None¶

Deletes a list of Test Parameter Definitions for the specified Project.

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

Deletes a list of Test Parameter Definitions for the specified Project.

Args:: project_id (str): body (TestparameterDefinitionsListDeleteRequest):
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.projects.delete_project_test_parameter_definitions.sync(project_id: str, *, client: AuthenticatedClient | Client, body: TestparameterDefinitionsListDeleteRequest) → Any | Errors | None¶

Deletes a list of Test Parameter Definitions for the specified Project.

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

Deletes a list of Test Parameter Definitions for the specified Project.

Args:: project_id (str): body (TestparameterDefinitionsListDeleteRequest):
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.projects.get_project module¶

async polarion_rest_api_client.open_api_client.api.projects.get_project.asyncio(project_id: 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 | ProjectsSingleGetResponse | None¶

Returns the specified Project.

Args:: project_id (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, ProjectsSingleGetResponse]

async polarion_rest_api_client.open_api_client.api.projects.get_project.asyncio_detailed(project_id: 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 | ProjectsSingleGetResponse]¶

Returns the specified Project.

Args:: project_id (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, ProjectsSingleGetResponse]]

polarion_rest_api_client.open_api_client.api.projects.get_project.sync(project_id: 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 | ProjectsSingleGetResponse | None¶

Returns the specified Project.

Args:: project_id (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, ProjectsSingleGetResponse]

polarion_rest_api_client.open_api_client.api.projects.get_project.sync_detailed(project_id: 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 | ProjectsSingleGetResponse]¶

Returns the specified Project.

Args:: project_id (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, ProjectsSingleGetResponse]]

polarion_rest_api_client.open_api_client.api.projects.get_project_test_parameter_definition module¶

async polarion_rest_api_client.open_api_client.api.projects.get_project_test_parameter_definition.asyncio(project_id: str, test_param_id: 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>) → Errors | TestparameterDefinitionsSingleGetResponse | None¶

Returns the specified Test Parameter Definition for the specified Project.

Args:: project_id (str): test_param_id (str): fields (Union[Unset, SparseFields]): include (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, TestparameterDefinitionsSingleGetResponse]

async polarion_rest_api_client.open_api_client.api.projects.get_project_test_parameter_definition.asyncio_detailed(project_id: str, test_param_id: 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>) → Response[Errors | TestparameterDefinitionsSingleGetResponse]¶

Returns the specified Test Parameter Definition for the specified Project.

Args:: project_id (str): test_param_id (str): fields (Union[Unset, SparseFields]): include (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, TestparameterDefinitionsSingleGetResponse]]

polarion_rest_api_client.open_api_client.api.projects.get_project_test_parameter_definition.sync(project_id: str, test_param_id: 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>) → Errors | TestparameterDefinitionsSingleGetResponse | None¶

Returns the specified Test Parameter Definition for the specified Project.

Args:: project_id (str): test_param_id (str): fields (Union[Unset, SparseFields]): include (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, TestparameterDefinitionsSingleGetResponse]

polarion_rest_api_client.open_api_client.api.projects.get_project_test_parameter_definition.sync_detailed(project_id: str, test_param_id: 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>) → Response[Errors | TestparameterDefinitionsSingleGetResponse]¶

Returns the specified Test Parameter Definition for the specified Project.

Args:: project_id (str): test_param_id (str): fields (Union[Unset, SparseFields]): include (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, TestparameterDefinitionsSingleGetResponse]]

polarion_rest_api_client.open_api_client.api.projects.get_project_test_parameter_definitions module¶

async polarion_rest_api_client.open_api_client.api.projects.get_project_test_parameter_definitions.asyncio(project_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>) → Errors | TestparameterDefinitionsListGetResponse | None¶

Returns a list of Test Parameter Definitions for the specified Project.

Args:: project_id (str): pagesize (Union[Unset, int]): pagenumber (Union[Unset, int]): fields (Union[Unset, SparseFields]): include (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, TestparameterDefinitionsListGetResponse]

async polarion_rest_api_client.open_api_client.api.projects.get_project_test_parameter_definitions.asyncio_detailed(project_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>) → Response[Errors | TestparameterDefinitionsListGetResponse]¶

Returns a list of Test Parameter Definitions for the specified Project.

Args:: project_id (str): pagesize (Union[Unset, int]): pagenumber (Union[Unset, int]): fields (Union[Unset, SparseFields]): include (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, TestparameterDefinitionsListGetResponse]]

polarion_rest_api_client.open_api_client.api.projects.get_project_test_parameter_definitions.sync(project_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>) → Errors | TestparameterDefinitionsListGetResponse | None¶

Returns a list of Test Parameter Definitions for the specified Project.

Args:: project_id (str): pagesize (Union[Unset, int]): pagenumber (Union[Unset, int]): fields (Union[Unset, SparseFields]): include (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, TestparameterDefinitionsListGetResponse]

polarion_rest_api_client.open_api_client.api.projects.get_project_test_parameter_definitions.sync_detailed(project_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>) → Response[Errors | TestparameterDefinitionsListGetResponse]¶

Returns a list of Test Parameter Definitions for the specified Project.

Args:: project_id (str): pagesize (Union[Unset, int]): pagenumber (Union[Unset, int]): fields (Union[Unset, SparseFields]): include (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, TestparameterDefinitionsListGetResponse]]

polarion_rest_api_client.open_api_client.api.projects.get_projects module¶

async polarion_rest_api_client.open_api_client.api.projects.get_projects.asyncio(*, 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>, query: ~polarion_rest_api_client.open_api_client.types.Unset | str = <polarion_rest_api_client.open_api_client.types.Unset object>, sort: ~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 | ProjectsListGetResponse | None¶

Returns a list of Projects.

Args:: pagesize (Union[Unset, int]): pagenumber (Union[Unset, int]): fields (Union[Unset, SparseFields]): include (Union[Unset, str]): query (Union[Unset, str]): sort (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, ProjectsListGetResponse]

async polarion_rest_api_client.open_api_client.api.projects.get_projects.asyncio_detailed(*, 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>, query: ~polarion_rest_api_client.open_api_client.types.Unset | str = <polarion_rest_api_client.open_api_client.types.Unset object>, sort: ~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 | ProjectsListGetResponse]¶

Returns a list of Projects.

Args:: pagesize (Union[Unset, int]): pagenumber (Union[Unset, int]): fields (Union[Unset, SparseFields]): include (Union[Unset, str]): query (Union[Unset, str]): sort (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, ProjectsListGetResponse]]

polarion_rest_api_client.open_api_client.api.projects.get_projects.sync(*, 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>, query: ~polarion_rest_api_client.open_api_client.types.Unset | str = <polarion_rest_api_client.open_api_client.types.Unset object>, sort: ~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 | ProjectsListGetResponse | None¶

Returns a list of Projects.

Args:: pagesize (Union[Unset, int]): pagenumber (Union[Unset, int]): fields (Union[Unset, SparseFields]): include (Union[Unset, str]): query (Union[Unset, str]): sort (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, ProjectsListGetResponse]

polarion_rest_api_client.open_api_client.api.projects.get_projects.sync_detailed(*, 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>, query: ~polarion_rest_api_client.open_api_client.types.Unset | str = <polarion_rest_api_client.open_api_client.types.Unset object>, sort: ~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 | ProjectsListGetResponse]¶

Returns a list of Projects.

Args:: pagesize (Union[Unset, int]): pagenumber (Union[Unset, int]): fields (Union[Unset, SparseFields]): include (Union[Unset, str]): query (Union[Unset, str]): sort (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, ProjectsListGetResponse]]

polarion_rest_api_client.open_api_client.api.projects.mark_project module¶

async polarion_rest_api_client.open_api_client.api.projects.mark_project.asyncio(*, client: AuthenticatedClient | Client, body: CreateProjectRequestBody) → Errors | JobsSinglePostResponse | None¶

Marks the Project.

Args:: body (CreateProjectRequestBody):
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, JobsSinglePostResponse]

async polarion_rest_api_client.open_api_client.api.projects.mark_project.asyncio_detailed(*, client: AuthenticatedClient | Client, body: CreateProjectRequestBody) → Response[Errors | JobsSinglePostResponse]¶

Marks the Project.

Args:: body (CreateProjectRequestBody):
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, JobsSinglePostResponse]]

polarion_rest_api_client.open_api_client.api.projects.mark_project.sync(*, client: AuthenticatedClient | Client, body: CreateProjectRequestBody) → Errors | JobsSinglePostResponse | None¶

Marks the Project.

Args:: body (CreateProjectRequestBody):
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, JobsSinglePostResponse]

polarion_rest_api_client.open_api_client.api.projects.mark_project.sync_detailed(*, client: AuthenticatedClient | Client, body: CreateProjectRequestBody) → Response[Errors | JobsSinglePostResponse]¶

Marks the Project.

Args:: body (CreateProjectRequestBody):
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, JobsSinglePostResponse]]

polarion_rest_api_client.open_api_client.api.projects.move_project_action module¶

async polarion_rest_api_client.open_api_client.api.projects.move_project_action.asyncio(project_id: str, *, client: AuthenticatedClient | Client, body: MoveProjectRequestBody) → Errors | JobsSinglePostResponse | None¶

Moves project to a different location.

Args:: project_id (str): body (MoveProjectRequestBody):
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, JobsSinglePostResponse]

async polarion_rest_api_client.open_api_client.api.projects.move_project_action.asyncio_detailed(project_id: str, *, client: AuthenticatedClient | Client, body: MoveProjectRequestBody) → Response[Errors | JobsSinglePostResponse]¶

Moves project to a different location.

Args:: project_id (str): body (MoveProjectRequestBody):
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, JobsSinglePostResponse]]

polarion_rest_api_client.open_api_client.api.projects.move_project_action.sync(project_id: str, *, client: AuthenticatedClient | Client, body: MoveProjectRequestBody) → Errors | JobsSinglePostResponse | None¶

Moves project to a different location.

Args:: project_id (str): body (MoveProjectRequestBody):
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, JobsSinglePostResponse]

polarion_rest_api_client.open_api_client.api.projects.move_project_action.sync_detailed(project_id: str, *, client: AuthenticatedClient | Client, body: MoveProjectRequestBody) → Response[Errors | JobsSinglePostResponse]¶

Moves project to a different location.

Args:: project_id (str): body (MoveProjectRequestBody):
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, JobsSinglePostResponse]]

polarion_rest_api_client.open_api_client.api.projects.patch_project module¶

async polarion_rest_api_client.open_api_client.api.projects.patch_project.asyncio(project_id: str, *, client: AuthenticatedClient | Client, body: ProjectsSinglePatchRequest) → Any | Errors | None¶

Updates the specified Project.

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

Updates the specified Project.

Args:: project_id (str): body (ProjectsSinglePatchRequest):
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.projects.patch_project.sync(project_id: str, *, client: AuthenticatedClient | Client, body: ProjectsSinglePatchRequest) → Any | Errors | None¶

Updates the specified Project.

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

Updates the specified Project.

Args:: project_id (str): body (ProjectsSinglePatchRequest):
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.projects.post_project_test_parameter_definitions module¶

async polarion_rest_api_client.open_api_client.api.projects.post_project_test_parameter_definitions.asyncio(project_id: str, *, client: AuthenticatedClient | Client, body: TestparameterDefinitionsListPostRequest) → Errors | TestparameterDefinitionsListPostResponse | None¶

Creates a list of Test Parameter Definitions for the specified Project.

Args:: project_id (str): body (TestparameterDefinitionsListPostRequest):
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, TestparameterDefinitionsListPostResponse]

async polarion_rest_api_client.open_api_client.api.projects.post_project_test_parameter_definitions.asyncio_detailed(project_id: str, *, client: AuthenticatedClient | Client, body: TestparameterDefinitionsListPostRequest) → Response[Errors | TestparameterDefinitionsListPostResponse]¶

Creates a list of Test Parameter Definitions for the specified Project.

Args:: project_id (str): body (TestparameterDefinitionsListPostRequest):
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, TestparameterDefinitionsListPostResponse]]

polarion_rest_api_client.open_api_client.api.projects.post_project_test_parameter_definitions.sync(project_id: str, *, client: AuthenticatedClient | Client, body: TestparameterDefinitionsListPostRequest) → Errors | TestparameterDefinitionsListPostResponse | None¶

Creates a list of Test Parameter Definitions for the specified Project.

Args:: project_id (str): body (TestparameterDefinitionsListPostRequest):
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, TestparameterDefinitionsListPostResponse]

polarion_rest_api_client.open_api_client.api.projects.post_project_test_parameter_definitions.sync_detailed(project_id: str, *, client: AuthenticatedClient | Client, body: TestparameterDefinitionsListPostRequest) → Response[Errors | TestparameterDefinitionsListPostResponse]¶

Creates a list of Test Parameter Definitions for the specified Project.

Args:: project_id (str): body (TestparameterDefinitionsListPostRequest):
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, TestparameterDefinitionsListPostResponse]]

polarion_rest_api_client.open_api_client.api.projects.unmark_project module¶

async polarion_rest_api_client.open_api_client.api.projects.unmark_project.asyncio(project_id: str, *, client: AuthenticatedClient | Client) → Errors | JobsSinglePostResponse | None¶

Unmarks the Project.

Args:: project_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:: Union[Errors, JobsSinglePostResponse]

async polarion_rest_api_client.open_api_client.api.projects.unmark_project.asyncio_detailed(project_id: str, *, client: AuthenticatedClient | Client) → Response[Errors | JobsSinglePostResponse]¶

Unmarks the Project.

Args:: project_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[Union[Errors, JobsSinglePostResponse]]

polarion_rest_api_client.open_api_client.api.projects.unmark_project.sync(project_id: str, *, client: AuthenticatedClient | Client) → Errors | JobsSinglePostResponse | None¶

Unmarks the Project.

Args:: project_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:: Union[Errors, JobsSinglePostResponse]

polarion_rest_api_client.open_api_client.api.projects.unmark_project.sync_detailed(project_id: str, *, client: AuthenticatedClient | Client) → Response[Errors | JobsSinglePostResponse]¶

Unmarks the Project.

Args:: project_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[Union[Errors, JobsSinglePostResponse]]